From ecfecf3f9e8c30f97c5126215ecdaf3e04469abd Mon Sep 17 00:00:00 2001
From: Miikka Virtanen <dragory.up@gmail.com>
Date: Fri, 10 Feb 2017 07:19:14 +0200
Subject: [PATCH] Add some documentation

---
 README.md           | 28 ++++++++++++++++++++++++++++
 config.example.json |  4 ++++
 package.json        |  4 ++--
 3 files changed, 34 insertions(+), 2 deletions(-)
 create mode 100644 README.md
 create mode 100644 config.example.json

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c5efc74
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# Modmail for Discord
+A bot for [Discord](https://discordapp.com/) that allows users to DM the bot to contact the server's entire mod team.
+These DMs get relayed to a modmail server where each user gets their own channel, or "thread".
+Moderators and admins can then reply to these threads, and these responses are relayed back to the original user as a DM.
+
+Inspired by Reddit's modmail system.
+
+## Setup
+1. Install Node.js 6 or higher
+2. Clone or download this repository
+3. Create a Discord server to be used as the modmail inbox
+4. Copy `config.example.json` to `config.json` and fill in the values
+5. Run the bot with `node src/index.js`
+
+## Commands
+
+##### Anywhere on the modmail inbox server
+`!logs <user>` Lists previous modmail logs with the specified user  
+`!block <user>` Blocks the specified user from using modmail  
+`!unblock <user>` Unblocks the specified user from using modmail
+
+##### Inside a modmail thread
+`!reply <text>` Sends a reply to the user in the format "(Role) User: text" (alias `!r`)  
+`!anonreply <text>` Sends an anonymous reply to the user in the format "Role: text"  
+`!close` Closes the modmail thread and saves a log of it  
+`!logs` Lists previous modmail logs with this user  
+`!block` Blocks the user from using modmail  
+`!unblock` Unblocks the user from using modmail
diff --git a/config.example.json b/config.example.json
new file mode 100644
index 0000000..82caeaf
--- /dev/null
+++ b/config.example.json
@@ -0,0 +1,4 @@
+{
+  "token": "your bot token",
+  "mailGuildId": "id of the modmail inbox guild"
+}
diff --git a/package.json b/package.json
index 911d2b9..f67d044 100644
--- a/package.json
+++ b/package.json
@@ -7,9 +7,9 @@
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "author": "",
-  "license": "ISC",
+  "license": "MIT",
   "dependencies": {
-    "eris": "github:abalabahaha/eris#dev",
+    "eris": "^0.5.2",
     "mime": "^1.3.4",
     "moment": "^2.17.1",
     "public-ip": "^2.0.1"