Skip to content

Commit d23de2d

Browse files
authored
Update README.md
1 parent fb67e54 commit d23de2d

File tree

1 file changed

+4
-48
lines changed

1 file changed

+4
-48
lines changed

README.md

Lines changed: 4 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -42,56 +42,12 @@ You have two options for using this bot, hosting on Heroku or self hosting the b
4242
## What is heroku?
4343
Heroku is a free hosting site that can host many web apps. However, these web apps cannot store any data on site. We have made Mod Mail to be accessible to anyone while still being feature rich, it's a community run project that lets anyone get it up and running 24/7 for free. So how does our bot store data? Config and logs are stored in a [centralised web service](https://modmail.tk) hosted by us. This enables you to get started fast without having to worry about [anything](https://github.com/kyb3r/modmail/wiki/Installation#transparency).
4444

45-
## Commands
46-
47-
### Modmail related
48-
49-
| Name | Command |
50-
|----------|------------------------------------------------------------|
51-
| setup | Sets up a server for modmail |
52-
| reply | Reply to users using this command. |
53-
| edit | Edit a message that was sent using the reply command. |
54-
| contact | Create a thread with a specified member. |
55-
| close | Close the current thread. |
56-
| move | Moves the thread channel to a specified category |
57-
| logs | Shows a list of previous modmail thread logs of a member. |
58-
| block | Block a user from using modmail. |
59-
| blocked | Returns a list of blocked users |
60-
| unblock | Unblocks a user from using modmail. |
61-
| nsfw | Flags a modmail thread as nsfw. |
62-
| snippets | Returns a list of snippets that are currently set. |
63-
| mention | Changes what the bot mentions at the start of each thread. |
64-
65-
### Utility commands
66-
| Name | Command |
67-
|----------|------------------------------------------------------------|
68-
| help | Shows the help message. |
69-
| update | Checks for new versions and updates the bot |
70-
| github | Shows the github user your modmail api token is linked to. |
71-
| prefix | Changes the prefix for the bot. |
72-
| alias | Returns a list of aliases that are currently set. |
73-
| about | Shows information about the bot. |
74-
| status | Set a custom playing status for the bot. |
75-
| ping | Pong! Returns your websocket latency. |
76-
| eval | Evaluates python code (Bot owner only) |
77-
| config | Manually change configuration for the bot. |
78-
79-
## Features
80-
81-
### Snippets and aliases
82-
Snippets are shortcuts for predefined messages that you can send. Add and remove snippets with the `snippets` command.
83-
84-
### Custom Mentions
85-
If you want the bot to mention a specific role instead of `@here`, use the `mention` command.
86-
87-
### Delete Linked Messages
88-
Did you accidentally send something you didnt mean to with the `reply` command? Dont fret, if you delete the original message on your side, this bot automatically deletes the corresponding message that was sent to the recipient of the thread! This also works with message edits in reverse.
89-
90-
### Thread Logs
91-
Thread conversations are automatically logged and a log link (logs.modmail.tk) is provided with each thread.
45+
## Features and Commands
46+
The bot comes with a plethora of useful functionality. Take a look at the [list of commands](https://github.com/kyb3r/modmail/wiki/Features-and-commands).
47+
9248

9349
### Automatic Updates
9450
The bot checks for new updates every hour and automatically updates to a newer version if found. You can disable this functionality by adding a `disable_autoupdates` config variable. This bot is under active development so you can always look forward to new, useful features!
9551

9652
## Contributing
97-
This project is licenced under MIT. Feel free to contribute to the development of this bot.
53+
This project is licenced under MIT. If you have ideas for commands create an issue or pull request. Contributions are always welcome, whether it be documentation improvements or new functionality, please feel free to create a pull request.

0 commit comments

Comments
 (0)