Clarify usage

This commit is contained in:
sim 2022-05-26 11:56:28 +02:00
parent 2c98460600
commit 4c8116175a
1 changed files with 12 additions and 10 deletions

View File

@ -1,32 +1,34 @@
# NextPush - Android
UnifiedPush provider for Nextcloud - android application
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
alt="Get it on F-Droid"
height="80">](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)