update readme

This commit is contained in:
Dave Umrysh 2021-03-10 13:27:35 -07:00
parent 946e7491cc
commit 400b79a1e5
1 changed files with 9 additions and 6 deletions

View File

@ -1,16 +1,18 @@
== sixtyfour
sixtyfour
==============
A messaging bridge between Matrix and 8x8 for maubot based on the maugitea plugin
WARNING: This bot is still under development, so things may change, break, or even work properly.
=== Install & Run
Install & Run
------------
sixtyfour: just a regular plugin, zip it and upload it.
=== Webhooks
Webhooks
------------
url: https://fancy.domain/_matrix/maubot/plugin/<instance_name>/webhook/r0?room=<room-id>
url: `https://fancy.domain/_matrix/maubot/plugin/<instance_name>/webhook/r0?room=<room-id>`
Add the secret to base-config.yaml
@ -22,7 +24,8 @@ Add your GCM key to base-config.yaml ([more information](https://cloud.ibm.com/d
Still a lot to do.
=== Bot usage
Bot usage
------------
!m your message goes here