Skip to content

Commit 7882563

Browse files
committed
Merge branch 'master' of https://github.com/verixx/modmail
2 parents d268381 + ed22851 commit 7882563

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,12 @@
3030

3131
## What is Modmail?
3232

33+
Modmail is akin to Reddit's Modmail both in functionality and purpose. It serves as a shared inbox/feed for server staff to communicate with the userbase and vice versa in a seamless way that DMing a single person never could achieve.
3334

34-
Modmail's core functionality provides an efficient way for server members to communicate with server staff. When a member sends a direct message to the bot, a channel or "thread" is created within an isolated category for that member. This channel is where messages will be relayed and where any available staff member can respond to that user.
35+
While the core functionality is to get into contact with the server personal, it's extended use includes but is not limited to organisational means. Feature or event requests, reporting other users and a comment/feedback/suggestion box under the guise of anonymity because Modmail threads aren't public.
36+
37+
## How does it work?
38+
When a member sends a direct message to the bot, a channel or "thread" is created within an isolated category for that member. This channel is where messages will be relayed and where any available staff member can respond to that user.
3539

3640
## Features
3741

@@ -59,7 +63,7 @@ This list is ever growing thanks to active development and our exceptional contr
5963
## Installation
6064

6165
### Heroku
62-
Currently, the easiest way to set up the bot is by using Heroku, a container-based cloud platform. Installation via Heroku is done in your web browser and keeps the bot online 24/7 for free. The [**installation guide**](https://github.com/kyb3r/modmail/wiki/Installation) will guide you through the entire installation process. If you run into any problems, join the [development server](https://discord.gg/etJNHCQ) for help and support.
66+
Currently, the easiest way to set up the bot is by using Heroku, a container-based cloud platform. Installation via Heroku is done in your web browser and keeps the bot online 24/7 for free (If you verify with a credit card). The [**installation guide**](https://github.com/kyb3r/modmail/wiki/Installation) will guide you through the entire installation process. If you run into any problems, join the [development server](https://discord.gg/etJNHCQ) for help and support.
6367

6468
### Locally
6569
Installation locally for development reasons or otherwise is as follows, you will need `python 3.7`.

0 commit comments

Comments
 (0)