diff --git a/README.md b/README.md index ac53498..7728c6f 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,17 @@ Moderators and admins can then reply to these threads, and these responses are r Inspired by Reddit's modmail system. +## Table of contents +- [Setup](#setup) +- [Changelog](#changelog) +- [Commands](#commands) + - [Anywhere on the inbox server](#anywhere-on-the-inbox-server) + - [Inside a modmail thread](#inside-a-modmail-thread) +- [Configuration options](#configuration-options) +- [Plugins](#plugins) + - [Specifying plugins to load](#specifying-plugins-to-load) + - [Creating a plugin](#creating-a-plugin) + ## Setup 1. Install Node.js 8.9.4 (LTS) or higher 2. Clone or download this repository @@ -20,7 +31,7 @@ See [CHANGELOG.md](CHANGELOG.md) ## Commands -##### Anywhere on the modmail inbox server +### Anywhere on the inbox server `!logs ` Lists previous modmail logs with the specified user `!block ` Blocks the specified user from using modmail `!unblock ` Unblocks the specified user from using modmail @@ -31,7 +42,7 @@ See [CHANGELOG.md](CHANGELOG.md) `!version` Print the version of the bot you're running `!newthread ` Opens a new thread with the specified user -##### Inside a modmail thread +### Inside a modmail thread `!reply ` Sends a reply to the user in the format "(Role) User: text" (alias `!r`) `!anonreply ` Sends an anonymous reply to the user in the format "Role: text" (alias `!ar`) `!close