aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4863c7f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Modmail for Discord
+Modmail Bot is a bot for [Discord](https://discordapp.com/) that allows users to DM the bot to contact the server's moderators/staff
+without messaging them individually or pinging them publically on the server.
+These DMs get relayed to modmail *threads*, channels where staff members can reply to and talk with the user.
+To the user, the entire process happens in DMs with the bot.
+
+Inspired by Reddit's modmail system.
+
+## Getting started
+* **[🛠️ Setting up the bot](docs/setup.md)**
+* [📝 Configuration](docs/configuration.md)
+* [🤖 Commands](docs/commands.md)
+* [🧩 Plugins](docs/plugins.md)
+* [🙋 Frequently Asked Questions](docs/faq.md)
+* [Release notes](CHANGELOG.md)
+
+## Support server
+If you need help with setting up the bot or would like to discuss other things related to it, join the support server on Discord here:
+
+👉 **[Join support server](https://discord.gg/vRuhG9R)**