Create usage documentation

readme.md

@@ -1,3 +1,8 @@
+# Max Bot
+## The Official Bot of the Full Sail Armada
+
+Interested in learning how to use Max? See the [Usage documentation here](usage.md).
+
 # Installation
 
 ### Prerequisites
@@ -39,7 +44,7 @@ module.exports = () => {
 
 Obtain a [Discord App Bot Token](https://discordapp.com/developers/applications/me) from your registered app (or register a new one) to proceed or contact a Release Manager for Max's Dev Bot token.
 
-Replace the ```{DiscordBotToken}``` within the ```.env``` file with the token provided to you.
+Replace the ```{DiscordBotToken}``` within the ```max.config.js``` file with the token provided to you.
 
 ### Adding the Bot to a Server
 
@@ -125,12 +130,22 @@ of this particular output should be. Reference the **Debug Level Chart**
 4. Highly Fine Grained Detailed and in-depth Output.
 
 
-# Database
-### how to connect using `SEQUEL PRO`
+# Modules & integrations
+
+## Database
+### How to connect using Sequel Pro
 
 You can find more information about the config file `db/config/config.json`
 
 ![](https://preview.ibb.co/d07YOG/Screen_Shot_2017_11_10_at_2_49_46_PM.png)
+
+## Nodemailer
+Max uses [Nodemailer](https://nodemailer.com/about/) to send verification emails to users joining the Armada server. Install Nodemailer with
+
+```
+npm install nodemailer --save
+```
+
 # Container Information
 
 ## Node Container

usage.md

@@ -0,0 +1,72 @@
+# Using Max
+
+As the official bot of the Full Sail Armada, Max offers simple but powerful automated user management tools that empower Armada members to verify membership eligibility and set roles for themselves within the server, freeing up admins, moderators, and officers for more important tasks.
+
+## Commands
+
+Each of the commands that Max offers can be invoked from inside a text channel by using an exclamation point followed by the command keyword (like `!command`). Individual commands are not case-sensitive, but some of the information needed for each command may be.
+
+### !help
+
+Example: `!help`
+
+Displays all of Max's available commands.
+
+### !verify
+
+Example: `!verify <email_address>`
+
+Verifies that the user has a valid Full Sail University email address and adds the user to the Discord server. This command also adds the user's username and FS email address to the Armada database so Armada officers can match users to real-life students.
+
+### !roles
+
+Example: `!roles`
+
+Sends a DM to the user with a list of all available Armada roles.
+
+### !addRole
+
+Example: `!addRole <role_name>`
+
+Adds the specified role to the user. Role names _are_ case-sensitive. Note that not all roles can be added this way—no promoting yourself to Fleet Officer, for example.
+
+### !addRoles
+
+Example: `!addRoles <role_name>,<role_name>,<role_name>`
+
+Adds multiple specified roles to the user all at once. The same caveat as above applies.
+
+### !removeRole
+
+Example: `!removeRole <role_name>`
+
+Removes a single specified role from the user.
+
+### !addAllRoles
+
+Example: `!addAllRoles`
+
+Adds all available Armada roles to the user. Suitable for masochists and chat room junkies.
+
+### !removeAllRoles
+
+Example: `!removeAllRoles`
+
+Removes all roles from the user. _Tabula rasa_, baby.
+
+
+## Administrative commands
+
+Max also includes a couple of special commands just for Officers and above for making announcements to multiple channels.
+
+### !shout
+
+Example: `!shout <channel_name> <channel_name> <channel_name> --m <message>`
+
+Sends a richly-formatted message to the selected text channels. Channel names _are_ case-sensitive and should be separated with spaces, not commas. Note the `--m` flag before the message—this tells Max you're done listing channels.
+
+### !shoutAll
+
+Example: `!shoutAll <message>`
+
+Sends a richly-formatted message to _all_ text channels. You can see why we only let Officers use this one.