Modified: README.md
This commit is contained in:
parent
424664d473
commit
e1d362d759
26
README.md
26
README.md
|
@ -3,18 +3,16 @@ This bot is designed to simplify the moderation and management of Telegram group
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
* Base admin commands
|
* User roles
|
||||||
* Member roles
|
* User complains system
|
||||||
* Report users
|
* Admin activity log
|
||||||
* User complaints
|
|
||||||
|
|
||||||
## Installation
|
## Up
|
||||||
|
|
||||||
- Required: python3.x, poetry/pip
|
- Required: python3.11
|
||||||
- Clone this repo
|
- Up Telegram Bot API server on port 5326
|
||||||
- Telegram API Service on port 5326(you can run systemd unit in systemd/)
|
- Use the .env.dist template example for creating .env
|
||||||
- Move the .env.dist text template to .env and configure him
|
- After first start use `!reload` for parsing members list and permissions
|
||||||
- First start use `!reload` for parsing members and permissions
|
|
||||||
|
|
||||||
## Configuration .env
|
## Configuration .env
|
||||||
|
|
||||||
|
@ -31,10 +29,10 @@ This bot is designed to simplify the moderation and management of Telegram group
|
||||||
|
|
||||||
## TODO
|
## TODO
|
||||||
|
|
||||||
- [x] Migrate to aiogram dev-3.0b6
|
- [ ] Multigroup support
|
||||||
- [ ] Docker
|
- [ ] Integrate project with docker
|
||||||
- [ ] Write antithrotling middleware(anti flood system)
|
- [ ] Flood detection
|
||||||
- [ ] Site for group moderator(in development)
|
- [ ] Web(in development)
|
||||||
|
|
||||||
## Support
|
## Support
|
||||||
|
|
||||||
|
|
Reference in New Issue