From 2c98460600af519bc14a8dfdcceee200d48137b0 Mon Sep 17 00:00:00 2001
From: tonytonyistony <53504611+tonytonyistony@users.noreply.github.com>
Date: Thu, 21 Apr 2022 15:41:01 -0700
Subject: [PATCH 1/2] Update README.md
Please provide some feedback on the above quotes so we can make these instructions more complete.
---
README.md | 22 +++++++++++++++++++++-
1 file changed, 21 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 3f0c362..de95fe2 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,29 @@ UnifiedPush provider for Nextcloud - android application
[](https://f-droid.org/packages/org.unifiedpush.distributor.nextpush/)
+## Requirements
+**Nextcloud Server**
+
+[Server App Install](https://github.com/UP-NextPush/server-app)
+
+**Android Apps**
+
+[Nextcloud Application](https://f-droid.org/packages/com.nextcloud.client/)
+
+[NextPush Client](https://f-droid.org/en/packages/org.unifiedpush.distributor.nextpush/)
+
+[Unified Push Client](https://unifiedpush.org/users/apps/)
+
+[Unified Push Test Client](https://f-droid.org/en/packages/org.unifiedpush.example/) - For testing purposes only. Not required for operation.
## Usage
-This application require the [server application](https://github.com/UP-NextPush/server-app) to be installed on the server and the [Nextcloud application](https://apps.nextcloud.com/apps/android_nextcloud_app) on the mobile phone.
+
+1. Install and sign into your Nextcloud account using the official Nextcloud sync client.
+2. Install the NextPush client and sign into you Nextcloud account.
+3. Install one of the supported Unified Push clients with the following url.
+`Please provide an example of the URL you are to input into the Unified Push Client`
+4. If step 3 did not work, install the UP-Example app and test your notification system.
+5. `Please provide a nextcloud usage that would send a notification to the phone for testing`
## Credit
This application has been inspired by [Nextcloud Push Notifier](https://gitlab.com/Nextcloud-Push/nextcloud-push-notifier)
From 4c8116175adaeefeb761a8124fab0bcedf519445 Mon Sep 17 00:00:00 2001
From: sim
Date: Thu, 26 May 2022 11:56:28 +0200
Subject: [PATCH 2/2] Clarify usage
---
README.md | 22 ++++++++++++----------
1 file changed, 12 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index de95fe2..91a1e48 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,34 @@
# NextPush - Android
+
UnifiedPush provider for Nextcloud - android application
[](https://f-droid.org/packages/org.unifiedpush.distributor.nextpush/)
+
## Requirements
+
**Nextcloud Server**
[Server App Install](https://github.com/UP-NextPush/server-app)
**Android Apps**
-[Nextcloud Application](https://f-droid.org/packages/com.nextcloud.client/)
+[1] [Nextcloud Application](https://f-droid.org/packages/com.nextcloud.client/) - **Required**
-[NextPush Client](https://f-droid.org/en/packages/org.unifiedpush.distributor.nextpush/)
+[2] [NextPush Client](https://f-droid.org/en/packages/org.unifiedpush.distributor.nextpush/) - This app
-[Unified Push Client](https://unifiedpush.org/users/apps/)
+[3] [Applications supporting UnifiedPush](https://unifiedpush.org/users/apps/)
-[Unified Push Test Client](https://f-droid.org/en/packages/org.unifiedpush.example/) - For testing purposes only. Not required for operation.
+[4] [UP-Example](https://f-droid.org/en/packages/org.unifiedpush.example/) - UnifiedPush Test Client - For testing purposes only. Not required for operation.
## Usage
-1. Install and sign into your Nextcloud account using the official Nextcloud sync client.
-2. Install the NextPush client and sign into you Nextcloud account.
-3. Install one of the supported Unified Push clients with the following url.
-`Please provide an example of the URL you are to input into the Unified Push Client`
-4. If step 3 did not work, install the UP-Example app and test your notification system.
-5. `Please provide a nextcloud usage that would send a notification to the phone for testing`
+1. Install and sign into your Nextcloud account using the official Nextcloud Application [1].
+2. Install the NextPush client [2] and sign into your Nextcloud account.
+3. Install one application supporting UnifiedPush [3], or UP-Example [4]. Login into the application if you need to, for instance with your mastodon account or with your matrix account.
+4. The application will automatically detect NextPush and use it to send notifications.
## Credit
+
This application has been inspired by [Nextcloud Push Notifier](https://gitlab.com/Nextcloud-Push/nextcloud-push-notifier)