~vpzom/shoved-matrix

18a27a136b18d6c771d21e9df9fc9f6745763069 — Colin Reeder 5 months ago be7bf23 master
Add README.md
1 files changed, 14 insertions(+), 0 deletions(-)

A README.md
A README.md => README.md +14 -0
@@ 0,0 1,14 @@
shoved-matrix
=============
A [shoved](https://sr.ht/~vpzom/shoved/) handler to receive notifications from Matrix.

To set up, run `./register.sh HOMESERVER_URL ACCESS_TOKEN`, replacing those values
appropriately.

**Note:** shoved-matrix currently only supports one account.

**Another note:** Matrix servers do not natively support Web Push, so shoved-matrix routes
notifications through my server (push.chat.vpzom.click). This server _will_ see the
event and room IDs for the notifications, but not their content. If you wish, you can
replace this with your own server running [Sygnal](https://github.com/matrix-org/sygnal/)
in register.sh.