From 9b2cdc7786e7b8867f5ff4447013568014aa462c Mon Sep 17 00:00:00 2001 From: kdusek Date: Fri, 28 Nov 2025 20:07:34 +0100 Subject: [PATCH] Update README.md with customization details --- README.md | 42 +++++++++++++++--------------------------- 1 file changed, 15 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index fb4be41..5c86f97 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,44 @@ -# Gotify Android [![Build Status][github-action-badge]][github-action] [![FOSSA Status][fossa-badge]][fossa] [![latest release version][release-badge]][release] [![F-Droid][fdroid-badge]][fdroid] +# Gotify Custom Android -Gotify Android connects to [gotify/server](https://github.com/gotify/server) and shows push notifications on new messages. +Gotify Custom Android is a customized version of the Gotify Android client that 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 +* filter notifications by priority (custom feature) ## Installation -Download the apk or get the app via F-Droid or Google Play. +Build the APK using the instructions below or download from the releases. -[Get it on Google Play][playstore] -[Get it on F-Droid][fdroid] -[Get it on F-Droid][release] - -Google Play and the Google Play logo are trademarks of Google LLC. +This is a custom build with package name `com.github.gotifycustom` to avoid conflicts with the original Gotify app. ### Disable battery optimization -By default Android kills long running apps as they drain the battery. With enabled battery optimization, Gotify will be killed and you wont receive any notifications. +By default Android kills long running apps as they drain the battery. With enabled battery optimization, Gotify Custom will be killed and you wont receive any notifications. -Here is one way to disable battery optimization for Gotify. +Here is one way to disable battery optimization for Gotify Custom. * Open "Settings" * Search for "Battery Optimization" -* Find "Gotify" and disable battery optimization +* Find "Gotify Custom" and disable battery optimization See also https://dontkillmyapp.com for phone manufacturer specific instructions to disable battery optimizations. -### Minimize the Gotify foreground notification +### Minimize the Gotify Custom foreground notification *Only possible for Android version >= 8* The foreground notification showing the connection status can be manually minimized to be less intrusive: -* Open Settings -> Apps -> Gotify +* Open Settings -> Apps -> Gotify Custom * Click Notifications -* Click on `Gotify foreground notification` +* Click on `Gotify Custom foreground notification` * Toggle the "Minimize" option / Select a different "Behavior" or "Importance" (depends on your Android version) -* Restart Gotify +* Restart Gotify Custom ## Message Priorities @@ -60,6 +57,8 @@ Use Java 17 and execute the following command to build the apk. $ ./gradlew build ``` +The APK will be in `app/build/outputs/apk/` with package name `com.github.gotifycustom`. + ## Update client * Run `./gradlew generateSwaggerCode` @@ -70,19 +69,8 @@ $ ./gradlew build * Commit changes ## 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). +We use [SemVer](http://semver.org/) for versioning. ## License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details - - [github-action-badge]: https://github.com/gotify/android/workflows/Build/badge.svg - [github-action]: https://github.com/gotify/android/actions?query=workflow%3ABuild - [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