Skip to content

Commit b93d787

Browse files
authored
Update README.md
1 parent fa2925b commit b93d787

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,24 @@ Currently the easiest and fastest way to set up the bot is using Heroku. If you
5050

5151
Heroku is a container based cloud platform that currently offers a free plan to host web apps. However, these apps have an ephemeral file system and thus cannot store any data on site. We have made Modmail 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? Configs and logs are stored in a [centralized web service](https://modmail.tk) hosted by us. This enables you to get started easily and fast. However, you do also have the option to self-host your data, check the installation guide for more info.
5252

53-
## Features and Commands
54-
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).
53+
## Notable Features
54+
55+
For a full list of commands check the [wiki](https://github.com/kyb3r/modmail/wiki).
56+
57+
### Snippets and aliases
58+
Snippets are shortcuts for predefined messages that you can send. Add and remove snippets with the `snippets` command. Custom command aliases are also supported with the `alias` command.
59+
60+
### Customizability
61+
There is a range of configuration variables you can dynamically change with the `config` command to change the appearance of the bot. For example embed color, responses, reactions etc. The list of things you can change is ever growing thanks to the community for code contributions.
62+
63+
### Linked Messages
64+
Did you accidentally send something you didn't mean to with the `reply` command? Don't 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 is due to the bot having linked messages, this also works when you use the `edit` command to edit a message you have sent.
65+
66+
### Thread Logs
67+
Thread conversations are automatically logged and a log link ([logs.modmail.tk](logs.modmail.tk)) is provided with each thread. Logs are rendered with HTML and are presented in an aesthetically pleasing way, exactly like on discord, this especially integrates seamlessly with the mobile version of discord.
68+
69+
<img src='https://i.imgur.com/eo3CwLm.png' height=350 align='center'></img>
70+
5571

5672
### Automatic Updates
5773
The bot checks for new updates every hour and automatically updates to a newer version if found. This bot is under active development so you can always look forward to new, useful features! If you do not want this functionality, for example, if you want to make changes to your fork, you can do so by adding a `disable_autoupdates` config variable.

0 commit comments

Comments
 (0)