Add README

This commit is contained in:
Sophie Tauchert 2023-01-08 15:21:01 +01:00
parent a7b8eda500
commit 11933649ac
No known key found for this signature in database
GPG key ID: 52701DE5F5F51125

11
README.md Normal file
View file

@ -0,0 +1,11 @@
# maubot-ntfy
This is a [maubot](https://maubot.xyz/) plugin to subscribe to [ntfy](https://ntfy.sh/) topics and send messages to a matrix room.
## Usage
Install as a maubot plugin and configure an instance. Alternatively, `@ntfy:catgirl.cloud` is available as well.
Use `!ntfy subscribe server/topic` (for example `!ntfy subscribe ntfy.sh/my_topic`) to subscribe the current room to the ntfy topic. Future messages will be sent to the room.
To unsubscribe, use `!ntfy unsubscribe server/topic`.