From 9c80395bffb770653e94d45d7bdf9ce8d99f534d Mon Sep 17 00:00:00 2001 From: Jackson Egan Date: Mon, 14 Sep 2020 23:52:12 -0400 Subject: [PATCH] Add welcome modules ro README --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index e1afbf2..f364f3b 100644 --- a/README.md +++ b/README.md @@ -161,6 +161,25 @@ This module is for interacting with the room that the commands are being execute * !room kicked: Lists the kicked users and their provided reason * !room state [event type] [optional state key]: Gets a state event with given event type and optional state key +### Welcome to Room + +When configured in a room, the bot will monitor a room for new users and send new users a welcome message 1:1. It will then notify bot owners of the new user. It will also, optionally, notify of user departure. + +Commands: + +* !welcome_room welcome_message [message] Sets the welcome message, along with other variables needed to detect new users. +* !welcome_room notify_departure [True/False] Sets whether bot owners will be notified of departure from room. Defaults to False. +* !welcome_room settings Shows the current settings for the welcome_room module. + +### Welcome to Server + +As a server admin, the bot will monitor new user creation on the server and send the welcome message to new users 1:1. It will then notify bot owners of the new user. + +Commands: + +* !welcome_server welcome_message [message] Sets the welcome message, along with other variables needed to detect new users. +* !welcome_server settings Shows current settings for the welcome_server module + ### Slow polling services These have the same usage - you can add one or more accounts to a room and bot polls the accounts.