Skip to content

Commit 2c04622

Browse files
committed
Updated README.md
1 parent 3fee32b commit 2c04622

File tree

3 files changed

+34
-30
lines changed

3 files changed

+34
-30
lines changed

README.md

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,6 @@
2525
<img src="https://img.shields.io/badge/Made%20With-Python%203.7-blue.svg?style=for-the-badge&logo=Python" alt="Made with Python 3.7">
2626
</a>
2727

28-
<a href="https://github.com/kyb3r/modmail/archive/master.zip">
29-
<img src="https://counter.modmail-plugins.ionadev.ml/embed/announcement">
30-
</a>
31-
3228
<a href="https://travis-ci.com/kyb3r/modmail">
3329
<img src="https://img.shields.io/travis/com/kyb3r/modmail?style=for-the-badge&logo=Travis">
3430
</a>
@@ -53,9 +49,10 @@ Modmail is similar to Reddit's Modmail both in functionality and purpose. It ser
5349
This bot is free for everyone and always will be. If you like this project and would like to show your appreciation, you can support us on **[Patreon](https://www.patreon.com/kyber)**, cool benefits included!
5450

5551
## How does it work?
56-
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.
5752

58-
All threads are logged and you can view previous threads through the corresponding generated log link. Here is an [**example**](https://logs.modmail.tk/example).
53+
When a member sends a direct message to the bot, Modmail will create a channel or "thread" within an isolated category. All further DM messages will automatically relay to that channel, for any available staff can respond within the channel.
54+
55+
All threads are logged and you can view previous threads through their corresponding log link. Here is an [**example**](https://logs.modmail.tk/example).
5956

6057
## Features
6158

@@ -65,46 +62,51 @@ All threads are logged and you can view previous threads through the correspondi
6562
* Interface elements (color, responses, reactions, etc).
6663
* Snippets and *command aliases*.
6764
* Minimum duration for accounts to be created before allowed to contact Modmail (`account_age`).
68-
* Minimum duration for member to be in the guild allowed to contact Modmail (`guild_age`).
65+
* Minimum duration for members to be in the guild before allowed to contact Modmail (`guild_age`).
66+
6967
* **Advanced Logging Functionality:**
70-
* When you close a thread, a [log link](https://logs.modmail.tk/example) is generated and posted to your log channel.
68+
* When you close a thread, Modmail will generate a [log link](https://logs.modmail.tk/example) and post it to your log channel.
7169
* Native Discord dark-mode feel.
7270
* Markdown/formatting support.
7371
* Login via Discord to protect your logs ([premium Patreon feature](https://patreon.com/kyber)).
7472
* See past logs of a user with `?logs`.
7573
* Searchable by text queries using `?logs search`.
74+
7675
* **Robust implementation:**
77-
* Scheduled tasks in human time, e.g. `?close in 2 hours silently`.
78-
* Editing and deleting messages are synced on all channels.
79-
* Support for the full range of message content (multiple images, files).
76+
* Schedule tasks in human time, e.g. `?close in 2 hours silently`.
77+
* Editing and deleting messages are synced.
78+
* Support for the diverse range of message contents (multiple images, files).
8079
* Paginated commands interfaces via reactions.
81-
80+
8281
This list is ever-growing thanks to active development and our exceptional contributors. See a full list of documented commands by using the `?help` command.
8382

8483
## Installation
8584

86-
<<<<<<< HEAD
85+
Where is the Modmail bot invite link? Unfortunately, due to how this bot functions, it cannot be invited. This is to ensure the individuality to your server and grant you full control over your bot and data. Nonetheless, you can easily obtain a free copy of Modmail for your server by following one of the methods listed below (roughly takes 15 minutes of your time):
86+
8787
### Heroku
8888

89-
This bot can be hosted on Heroku.
89+
This bot can be hosted on Heroku.
9090

91-
Installation via Heroku is possible with only your web browser.
92-
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.
91+
Installation via Heroku is possible with your web browser alone.
92+
The [**installation guide**](https://github.com/kyb3r/modmail/wiki/Installation) (which includes a video tutorial!) will guide you through the entire installation process. If you run into any problems, join our [Modmail Discord Server](https://discord.gg/etJNHCQ) for help and support.
9393

94-
You can also set up auto-update. To do this:
94+
To configure automatic updates:
95+
- Login to [GitHub](https://github.com/) and verify your account.
9596
- [Fork the repo](https://github.com/kyb3r/modmail/fork).
96-
- [Install the Pull app for your fork](https://github.com/apps/pull).
97-
- Then go to the Deploy tab in your Heroku account, select GitHub and connect your fork.
97+
- Install the [Pull app](https://github.com/apps/pull) for your fork.
98+
- Then go to the Deploy tab in your [Heroku account](https://dashboard.heroku.com/apps) of your bot app, select GitHub and connect your fork (usually by typing "Modmail").
9899
- Turn on auto-deploy for the `master` branch.
99100

100101
### Hosting for patrons
101102

102-
If you don't want to go through the trouble of setting up your own bot, and want to support this project as well, we offer installation, hosting and maintenance for Modmail bots for [**Patrons**](https://patreon.com/kyber). Join the support server for more info!
103+
If you don't want to go through the trouble of setting up your very own Modmail bot, and/or want to support this project, we offer the all inclusive installation, hosting and maintenance of your Modmail with [**Patron**](https://patreon.com/kyber). Join our [Modmail Discord Server](https://discord.gg/etJNHCQ) for more info!
103104

104105
### Locally
105106

106-
Installation locally for development reasons or otherwise is as follows, you will need [`python 3.7`](https://www.python.org/downloads/).
107-
Follow the [**installation guide**](https://github.com/kyb3r/modmail/wiki/Installation) and disregard deploying Heroku apps. If you run into any problems, join the [development server](https://discord.gg/etJNHCQ) for help and support.
107+
Local hosting of Modmail is also possible, first you will need [`python 3.7`](https://www.python.org/downloads/).
108+
109+
Follow the [**installation guide**](https://github.com/kyb3r/modmail/wiki/Installation) and disregard deploying the Heroku bot application. If you run into any problems, join our [Modmail Discord Server](https://discord.gg/etJNHCQ) for help and support.
108110

109111
Clone the repo:
110112

@@ -119,9 +121,9 @@ Install dependencies:
119121
$ pipenv install
120122
```
121123

122-
Rename the `.env.example` to `.env` and fill out the fields. If `.env.example` is hidden, create a text file named `.env` and copy the contents of [`.env.example`](https://raw.githubusercontent.com/kyb3r/modmail/master/.env.example) then modify the values.
124+
Rename the `.env.example` to `.env` and fill out the fields. If `.env.example` is nonexistent (hidden), create a text file named `.env` and copy the contents of [`.env.example`](https://raw.githubusercontent.com/kyb3r/modmail/master/.env.example) then modify the values.
123125

124-
Finally, run the bot.
126+
Finally, start Modmail.
125127

126128
```console
127129
$ pipenv run bot
@@ -135,14 +137,16 @@ Special thanks to our sponsors for supporting the project.
135137
<img height=150 src='https://i.imgur.com/WyzaPKY.png' style='margin:10'>
136138
</a>
137139

138-
Become a [sponsor](https://patreon.com/kyber).
140+
Become a sponsor on [Patreon](https://patreon.com/kyber).
139141

140142
## Plugins
141143

142-
Modmail supports the use of third-party plugins to extend or add functionality to the bot. This allows the introduction of niche features as well as anything else outside of the scope of the core functionality of Modmail. A list of third party plugins can be found using the `plugins registry` command. To develop your own, check out the [documentation](https://github.com/kyb3r/modmail/wiki/Plugins) for plugins.
144+
Modmail supports the use of third-party plugins to extend or add functionalities to the bot. This allows niche features as well as anything else outside of the scope of the core functionality of Modmail. A list of third-party plugins can be found using the `plugins registry` command. To develop your own, check out the [plugins documentation](https://github.com/kyb3r/modmail/wiki/Plugins).
145+
146+
Plugins requests and support is available in our (Modmail Plugins Server)[https://discord.gg/4JE4XSW].
143147

144148
## Contributing
145149

146-
Contributions to Modmail are always welcome, whether it be improvements to the documentation or new functionality, please feel free to make the change. Check out our contribution [guidelines](https://github.com/kyb3r/modmail/blob/master/CONTRIBUTING.md) before you get started.
150+
Contributions to Modmail are always welcome, whether it be improvements to the documentation or new functionality, please feel free to make the change. Check out our contribution [guidelines](https://github.com/kyb3r/modmail/blob/master/CONTRIBUTING.md) before you get started.
147151

148-
This bot is free for everyone and always will be. If you like this project and would like to show your appreciation, here's the link to our **[Patreon Page](https://www.patreon.com/kyber)**!
152+
If you like this project and would like to show your appreciation, support us on **[Patreon](https://www.patreon.com/kyber)**!

core/paginator.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ async def show_page(self, index: int) -> None:
9494
page = self.pages[index]
9595

9696
if self.running:
97-
return await self._show_page(page)
97+
await self._show_page(page)
9898
else:
9999
await self.create_base(page)
100100

core/utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
import shlex
33
import typing
44
from difflib import get_close_matches
5-
from distutils.util import strtobool as _stb
5+
from distutils.util import strtobool as _stb # pylint: disable=import-error
66
from itertools import takewhile
77
from urllib import parse
88

0 commit comments

Comments
 (0)