Update README.md

This commit is contained in:
Philipp C. Heckel 2021-11-23 23:18:17 -05:00 committed by GitHub
parent 38696d4140
commit 5b33d86cfa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -2,6 +2,19 @@
This is the Android app for [ntfy](https://github.com/binwiederhier/ntfy) ([ntfy.sh](https://ntfy.sh)). It is available
in the [Play Store](https://play.google.com/store/apps/details?id=io.heckel.ntfy).
# Releases
You can find the app in the [Play Store](https://play.google.com/store/apps/details?id=io.heckel.ntfy), or as .apk files on the [releases page](https://github.com/binwiederhier/ntfy-android/releases).
There is a ticket to create an [F-Droid version](https://github.com/binwiederhier/ntfy/issues/7), but I haven't had the time yet.
# Build instructions
(Todo)
## Building with your own Firebase Cloud Messaging (FCM) account
To build your own version with Firebase, you must:
* Put your own `google-services.json` file in the [app/ folder](https://github.com/binwiederhier/ntfy-android/tree/main/app)
* And change `app_base_url` in [strings.xml](https://github.com/binwiederhier/ntfy-android/blob/main/app/src/main/res/values/strings.xml)
## License
Made with ❤️ by [Philipp C. Heckel](https://heckel.io), distributed under the [Apache License 2.0](LICENSE).