Skip to content

Commit 5795efd

Browse files
authored
rewrite README
1 parent 3e3906d commit 5795efd

File tree

1 file changed

+44
-13
lines changed

1 file changed

+44
-13
lines changed

README.md

Lines changed: 44 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,58 @@
11
# discordbot
22

3-
### [!] Some Notes:
4-
1.First of all, go to src folder and install requirements by `pip3 install -r requirements.txt` then run the program by `python3 bot.py`
3+
This is a moderation bot for Discord servers that provides several features to help the server staff manage and maintain the server. The following are the features of this bot:
54

6-
2.you need create your bot in [discord developer portal](https://discord.com/developers) link and then copy your bot token and Then paste in the location specified in the file (bot.py)((you can see [this](https://www.youtube.com/watch?v=nW8c7vT6Hl4&list=PLW3GfRiBCHOhfVoiDZpSz8SM_HybXRPzZ) video to learn how create discord bot))
5+
- Timeout of users
76

8-
3.This program is not really my main discord bot🤖. It is a template that I have followed to write my own discord bot.
7+
- Kicking users
98

10-
4.This is an admin bot that makes it easier for you to manage your Discord servers😉.
9+
- Locking channels
1110

12-
5.This project is currently its first Beta version. Soon, features such as game dosing and new features as well as better features to improve its performance will be added to this project💪💪💪.
11+
- Giving a role to the user
1312

14-
6.Be sure to fork this project and implement your ideas on it💡.
13+
- Removing a role from the user
1514

16-
7.Please email me your feedback from this project: shahriaarrr@gmail.com
15+
- Contact form with Discord server staff
1716

18-
8.Also, if you like this project, be sure to give it a star⭐.
17+
- About section to put the server description
1918

20-
9.7-Finally, I hope you use this program properly and enjoy working with it 😉
19+
## Installation
20+
- To run this bot, you need to install the following libraries:
21+
22+
- discord.py
23+
- python-dotenv
24+
25+
- You can install these libraries using pip by running the following command:
26+
```
27+
$ pipenv install
28+
```
29+
- After installing the required libraries, you need to create a .env file in the root directory of the project and add the following variables:
30+
```env
31+
TOKEN=<your_bot_token>
32+
```
33+
- Replace `<your_bot_token>` with the bot token provided by Discord.
34+
35+
### run
36+
- To run the bot, you need to execute the main.py file using the following command:
37+
```
38+
$ python main.py
39+
```
40+
41+
42+
## [!] Some Notes:
43+
44+
1. you need create your bot in [discord developer portal](https://discord.com/developers) link and then copy your bot token and Then paste in the location specified in the file (bot.py)((you can see [this](https://www.youtube.com/watch?v=nW8c7vT6Hl4&list=PLW3GfRiBCHOhfVoiDZpSz8SM_HybXRPzZ) video to learn how create discord bot))
45+
46+
2. This is an admin bot that makes it easier for you to manage your Discord servers😉.
47+
48+
3. Be sure to fork this project and implement your ideas on it💡.
49+
50+
4. Also, if you like this project, be sure to give it a star⭐.
51+
52+
5. Finally, I hope you use this program properly and enjoy working with it 😉
2153

2254
### Thanks to:
23-
1.Special thanks to my dear friend, brother and mentor [Amir Hossein](https://www.linkedin.com/in/amirtoday) for his help and suggestions for this project🧡🙏.
2455

25-
2.2.Also, my dear friend [Matin](https://github.com/ThisIsMatin), for his good education and help that he gave me🙏
56+
1. my dear friend **SECTOR**, for his good education and help that he gave me🙏
2657

27-
3.Also from my parents for the support they give me and the encouragement they give me in this way❤🙏.
58+
2. **boby cloud** for his advice and mentorship to improve this README

0 commit comments

Comments
 (0)