Added README
This commit is contained in:
parent
0f35acd93e
commit
31dee0a325
|
@ -0,0 +1,16 @@
|
|||
# AutoBanBot
|
||||
|
||||
Automatically kicks and bans users, which first name or last name matches one of predefined regexes,
|
||||
from a telegram group.
|
||||
|
||||
## Running
|
||||
|
||||
Before running the bot, configure the Telegram Bot API and regexes in `config.json`.
|
||||
An `config.json.example` file is provided with example values.
|
||||
|
||||
```bash
|
||||
$ virtualenv -p python3 virtual
|
||||
$ source virtual/bin/activate
|
||||
$ pip install -r requirements.txt
|
||||
$ ./autobanbot.py
|
||||
```
|
Loading…
Reference in New Issue