Messages documentation

2017-05-02 18:50:43 -04:00
parent a00b73a0c3
commit 9994b8ab6d
1 changed files with 29 additions and 0 deletions
--- a/docs/features/messages.rst
+++ b/docs/features/messages.rst
@ -0,0 +1,29 @@
+Join/Leave Messages
+===================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+Messages
+--------
+
+|project| can send messages when members join and leave the server.
+
+Message Channel
+---------------
+
+The message channel will be used to send messages when people join or leave the server.
+
+Usage:
+
+   !!messagechannel [#channel]
+
+Setting the join or leave messages
+----------------------------------
+
+To change the join/leave message, use the `!!message` text command.
+
+   !!message <join/leave> "Message enclosed in quotes"
+
+You can use the replacement variables `{highlight}` and `{username}` to replace the text with a highlight/mention, or their username.