Improved Readme #794
Improved Readme #794
Conversation
|
Thank you for your pull request and welcome to our community! We require contributors to sign our Contributor License Agreement, and we don't seem to have the user @aha999 on file. In order for your code to get reviewed and merged, please explicitly state that you accept the agreement. Alternatively, you can add a commit that adds yourself to https://github.com/grote/Transportr/blob/master/.clabot |
|
I accept the agreement |
|
This PR conflicts with the current master branch, so for a merge this would need to be resolved. |
|
Also, with these changes every load of the README issues a lot of third-party requests. Not sure if we'd want that. |
Are those really generating third-party requests? Are they not loaded through github servers? |
At least when looking at the (rendered) Markdown locally. |
|
@Altonss i make that many merges, because i don't change everything in one try, so sometimes i save and continue later. |
|
I just double-checked and after the changes, the README only loads images additionally from shields.io. I think that's actually fine with me. |
|
|
||
| The public transport companion that respects your privacy and your freedom. | ||
| Transportr is a non-profit app developed by people around the world to make using public transport as easy as possible wherever you are. | ||
|
|
||
| [](https://transportr.app) | ||
| [](https://travis-ci.org/grote/Transportr) |
There was a problem hiding this comment.
This one doesn't work anymore. Anyone knows how to get the build status from the Github CI instead?
There was a problem hiding this comment.
Wouldn't the current one used in the README.md (
)
[](https://github.com/grote/Transportr/actions/workflows/build.yml)
work just fine?
|
|
||
| Please **[visit the website](https://transportr.app)** for more information! | ||
| * Pre-releases and beta versions for advanced users are available via [a special F-Droid repository](http://grobox.de/fdroid/). |
There was a problem hiding this comment.
I wouldn't add a bullet point here.
|
|
||
| The upstream repository is at: https://github.com/grote/Transportr | ||
| [<img src="https://user-images.githubusercontent.com/50620416/140822064-86778b46-f701-40b0-a9bd-fc10d1397f0f.gif" height="444">](https://transportr.app/img/transportr.webm) |
There was a problem hiding this comment.
Where does this come from? Is it a gif or a webm video? In either case, it should be added to the repo if we want to show it in the README.
| * Share Transportr on social media or show your friends and family that it exists and how to use it. | ||
| * If you find any issues with this app, please report them at [the issue tracker](https://github.com/grote/Transportr/issues). | ||
| * Rate it in [Google Play](https://play.google.com/store/apps/details?id=de.grobox.liberario) and if you have a little more time also write a short review about it. | ||
| * Add more supported regions by contributing to the [Transport-Enabler](https://github.com/schildbach/public-transport-enabler/) project, which is used by Transportr. More methods are explained on the website. |
There was a problem hiding this comment.
The library is called Public Transport Enabler (PTE)
| </tr> | ||
| <tr> | ||
| <td align="center"><a href="bitcoin:12JaQp8zfqRb83JfSwVjH4rZWsZnWRPoyG"><img src="https://transportr.app/img/bitcoin-qr.png" alt="bitcoin:12JaQp8zfqRb83JfSwVjH4rZWsZnWRPoyG" width="128px" height="128px"></a></td> | ||
| <td align="center">Bitcoin</a></td> |
There was a problem hiding this comment.
@grote Do you still want to accept donations via Bitcoin?
There was a problem hiding this comment.
I don't care either way. The original address should still work and I have still the key, but distributing it to other people is more difficult, so LiberaPay is probably better.
|
The badges have been fixed in #955, so I'll close this PR for now as the scope of this PR seems too big. Feel free to reopen maybe smaller PRs easier to review :) |
I have improved readme by adding new content like new high resolution download icons, gif next to the screenshots, donation info, contribution info etc. generally it looks and functions better. It was made because of the issue #777
You can see it in my fork: https://github.com/aha999/Transportr