Improve readme

This commit is contained in:
Jannis Mattheis
2018-12-22 19:20:11 +01:00
parent 7da23cf94a
commit d85ad224f7
2 changed files with 34 additions and 3 deletions

View File

@@ -1,14 +1,45 @@
# Gotify Android [![Build Status][badge-travis]][travis]
# Gotify Android [![Build Status][travis-badge]][travis] [![FOSSA Status][fossa-badge]][fossa] [![latest release version][release-badge]][release] [![F-Droid][fdroid-badge]][fdroid]
![gotify gif](app.gif)
<img align="right" src="app.gif" width="250" />
Gotify Android connects to [gotify/server](https://github.com/gotify/server) and shows push notifications on new messages.
## Features
* show push notifications on new messages
* view and delete messages
## Installation
Download the apk or get the app via F-Droid or Google Play.
[<img src="https://play.google.com/intl/en_gb/badges/images/generic/en_badge_web_generic.png" alt="Get it on Google Play" width="150" />][playstore]
[<img src="https://f-droid.org/badge/get-it-on.png" alt="Get it on F-Droid" width="150"/>][fdroid]
[<img src="download-badge.png" alt="Get it on F-Droid" width="150"/>][release]
Google Play and the Google Play logo are trademarks of Google LLC.
[badge-travis]: https://travis-ci.org/gotify/android.svg?branch=master
## Building
Execute the following command to build the apk.
```bash
$ ./gradlew build
```
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the
[tags on this repository](https://github.com/gotify/android/tags).
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
[travis-badge]: https://travis-ci.org/gotify/android.svg?branch=master
[travis]: https://travis-ci.org/gotify/android
[playstore]: https://play.google.com/store/apps/details?id=com.github.gotify
[fdroid-badge]: https://img.shields.io/f-droid/v/com.github.gotify.svg
[fdroid]: https://f-droid.org/de/packages/com.github.gotify/
[fossa-badge]: https://app.fossa.io/api/projects/git%2Bgithub.com%2Fgotify%2Fandroid.svg?type=shield
[fossa]: https://app.fossa.io/projects/git%2Bgithub.com%2Fgotify%2Fandroid
[release-badge]: https://img.shields.io/github/release/gotify/android.svg
[release]: https://github.com/gotify/android/releases/latest

BIN
download-badge.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB