diff --git a/README.md b/README.md index 1fcd6bc..f5a2dcf 100644 --- a/README.md +++ b/README.md @@ -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 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 -* 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. * 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) \ No newline at end of file