aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 10 insertions, 14 deletions
diff --git a/README.md b/README.md
index a8cc41c..b76569f 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,21 @@
-# Ponypush
-This is a fork of the [ntfy Android app](https://github.com/binwiederhier/ntfy) ([ntfy.sh](https://ntfy.sh)) made to work with Equestria.dev's notification servers and other technologies. It is not meant to be used outside of Equestria.dev's services.
+# Haven
+This app started as a fork of the [ntfy Android app](https://github.com/binwiederhier/ntfy) ([ntfy.sh](https://ntfy.sh)) made to work with Equestria.dev's notification servers and other technologies and eventually turned into a mobile app for various Equestria.dev services. It is not meant to be used outside of Equestria.dev and will not work without the Equestria.dev servers.
-## Build
+> **Note for Ponypush users:** Upgrading from Ponypush (`dev.equestria.notifications`) is not possible as Haven (`dev.equestria.haven`) uses a different package name. Therefore, you will need to uninstall Ponypush and then install Haven (or keep both installed).
-### Building without Firebase ("F-Droid flavor", using WebSockets)
+## Build
In Android Studio, go to Build > Generate Signed Bundle/APK and select `fdroidDebug` or `fdroidRelease`.
-### Building with Firebase ("Google Play flavor", using Firebase Cloud Messaging)
-To build your own version with Firebase, you must:
-* Create a Firebase account and create an Android app on it
-* Place your account file at `app/google-services.json`
-* In Android Studio, go to Build > Generate Signed Bundle/APK and select `playDebug` or `playRelease`.
-
-## Notable differences
+## Notable differences with upstream ntfy
- Revamped UI, with a lot of options removed
- Most notably, it is not possible to use a third-party server other than notifications.equestria.dev
- Integration with Equestria.dev's tags
-- Firebase Cloud Messaging support for notifications.equestria.dev
+- Targets Android 15 instead of the upstream Android 13
+- Requires Android 9 or later instead of Android 5.0 or later
+- Up-to-date dependencies
## Upstream integration
-When notable changes are made upstream (on the official ntfy app), Ponypush will attempt to integrate such changes as much as possible. However, we cannot guarantee that the implemented features will work the same as with the official ntfy app.
+When notable changes are made to the official ntfy app, Haven will attempt to integrate such changes as much as possible. However, we cannot guarantee that the implemented features will work the same as with the official ntfy app.
## License
-This is a fork of ntfy by [Philipp C. Heckel](https://heckel.io), distributed under the [Apache License 2.0](LICENSE) like the original project. \ No newline at end of file
+This is a fork of ntfy by [Philipp C. Heckel](https://heckel.io), originally distributed under the Apache License 2.0. This modified application is released under the [GNU Affero General Public License version 3](LICENSE) as per Equestria.dev's policy. \ No newline at end of file