You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-48Lines changed: 4 additions & 48 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,56 +42,12 @@ You have two options for using this bot, hosting on Heroku or self hosting the b
42
42
## What is heroku?
43
43
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).
| 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
+
92
48
93
49
### Automatic Updates
94
50
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!
95
51
96
52
## 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