Netsyms/matrix-bridge-voxtelesys
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add commands to README

Browse Source
This commit is contained in:
Skylar Ittner 2022-06-09 12:51:27 -06:00
parent d3b39da3c0
commit a25be8e410
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -49,9 +49,16 @@ When a SMS is received from a new number, a new room is created. If you need to
a new number, simply type something like `!sms 14065551234` into an existing SMS room. You'll be a new number, simply type something like `!sms 14065551234` into an existing SMS room. You'll be
invited to join a new room and will then be able to send your message. invited to join a new room and will then be able to send your message.
## Chat Commands
Chat commands can be issued in any room the bot is joined to.
* `!sms 1234567890`: Create a new empty SMS room for the provided phone number, and invite all `invitusers` to the room. Texts will send from the `smsfrom` number.
* `!sms 1234567890 9876543210`: Create a new empty SMS room, and invite all `invitusers` to the room, as above. Texts will send from the second number entered.
* `!fixusers`: Goes through all the SMS rooms, checking membership against `inviteusers`. If anyone's missing from a room, they're invited back.
## Known Issues/Limitations ## Known Issues/Limitations
* If you leave a room the bot won't invite you back, even if there are new SMS messages.
* Any messages posted in a Matrix room while the bot is offline will not be relayed to SMS when it comes back. * Any messages posted in a Matrix room while the bot is offline will not be relayed to SMS when it comes back.
* Only unread SMS are fetched, so if anything else is checking the API this bot won't get those. * Only unread SMS are fetched, so if anything else is checking the API this bot won't get those.
* If it crashes try the latest [Node.js LTS](https://github.com/nodesource/distributions) (v14 as of commit date) * If it crashes try the latest [Node.js LTS](https://github.com/nodesource/distributions) (v14 as of commit date)