From 147639bfc8d87cf15c3d0153c634ca43015cdf4d Mon Sep 17 00:00:00 2001 From: Jake Mattson Date: Fri, 22 Jul 2022 02:22:33 -0500 Subject: [PATCH] Update README.md --- README.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index c757097..2d88486 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,9 @@

- Kotlin + Kotlin - DiscordKt -
- - Release - - - Docker + DiscordKt
@@ -18,31 +12,40 @@

# ModMail + ModMail is a Discord bot designed to provide a communication system between server staff and other members. ## Reports + Reports are private text channels that allow the entire staff team to communicate with a single member. ![Reports](https://i.imgur.com/7vgwc9E.png) ### Creating Reports + Reports will be opened automatically whenever a user messages the bot. -The `Open` command can be used to open a report manually, or `Detain` if you want to mute them as well. +The `/Open` command can be used to open a report manually, or `/Detain` if you want to mute them as well. ### Using a Report + Once a report is opened, anyone with access to this private channel can talk with the user through the bot. The user only needs to talk with the bot like a normal DM. #### Closing a Report + ##### From Discord - * Delete the channel - ModMail will detect the event and close the report for you. + +* Delete the channel - ModMail will detect the event and close the report for you. ##### Using Commands - * `Close` - This has the same effect as deleting the channel. - * `Archive` - Transcribes the report to text, archives it, then closes the report. + +* `/Close` - This has the same effect as deleting the channel. +* `/Archive` - Transcribes the report to text, archives it, then closes the report. ## Setup + Refer to the [setup](setup.md) instructions. ## Commands + To see available commands, use `Help` or read the [commands](commands.md) documentation. \ No newline at end of file