Skip to content

Commit

Permalink
📝 add notifications.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RustySnek authored May 30, 2024
1 parent 87a4d0c commit 2fc0046
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/notifications.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Notifications

## Elixirus supports [ntfy.sh](https://ntfy.sh) notifications
Notifications are only present when `keep token alive` is enabled. By default notifications are refreshed every 10 minutes.

### Install ntfy.sh app
To get started, download the ntfy.sh app on your device:
- [F-Droid](https://f-droid.org/en/packages/io.heckel.ntfy/)
- [Google Play](https://play.google.com/store/apps/details?id=io.heckel.ntfy)
- [App store](https://apps.apple.com/us/app/ntfy/id1625396347)
### Enable notifications during sign-in and subscribe to topic

![image](https://github.com/RustySnek/Elixirus/assets/73820224/f30966f4-7bc7-42ee-8cd8-0be6e847dc23)
### On mobile `Open ntfy.sh` button should automatically subscribe you to your unique topic id
- New topic id is assigned every time you sign in with ntfy enabled
- Multiple devices can subscribe to the same topic

![image](https://github.com/RustySnek/Elixirus/assets/73820224/153d685e-bafa-495b-887e-d1040f1c5e47)

# Example notifications
<img src="https://github.com/RustySnek/Elixirus/assets/73820224/1dfa2797-a1da-4759-9329-263f365c802e" width="250" height="250" alt="example notifications"></img>
<img src="https://github.com/RustySnek/Elixirus/assets/73820224/10667375-a950-4f95-90eb-575644150fd5" width="250" height="250" alt="example notifications"></img>
<img src="https://github.com/RustySnek/Elixirus/blob/ntfy_notifications/images/notifications_example_2.png" width="250" height="250" alt="example notifications"></img>

0 comments on commit 2fc0046

Please sign in to comment.