[repo] Add README.

This README are better than Poki's README commit on 686dd0b191.

Signed-off-by: Andrei Jiroh Eugenio Halili <andreijiroh@madebythepins.tk>
This commit is contained in:
Andrei Jiroh Eugenio Halili 2020-07-25 08:59:58 +00:00
parent f7b57f26fd
commit c09e9dceff
1 changed files with 33 additions and 0 deletions

33
README.md Normal file
View File

@ -0,0 +1,33 @@
# Intellivoid SpamProtection Agent Userbot
An userbot that automates the process of reporting spam for [Spam Protection](https://t.me/SpamProtectionLogs).
## Terms of Service
By using this userbot (or any userbot), you agree:
- **that this userbot is for agents of SP**. Please join the Support chat and ask us that you want to use this.
- **that you must notify Telegram that you're using an userbot**. When or before you first sign up or login you have to
send an email with the phone number to <recover@telegram.org>; explaining what will your userbot do. PLEASE DO NOT LIE, just
tell them what your userbot will do.
- **to the [Telegram TOS](https://telegram.org/tos) and its [API TOS](https://core.telegram.org/api/terms)**.
Please be reminded that we're NOT responsible for your TOS violations.
## Setting up
### Run Locally
1. Clone the repository and navigate to it.
2. Install dependencies with `pip install -r requirements.txt`.
3. Copy the sample config file with `cp spam/config.sample.py spam/config.py` and edit it.
4. After setting up, run `python3 -m spam`.
### With Heroku
Soon.
## Community Support
If you need help setting up this userbot or gone into trouble while running it, join the [Spam Protection Support][sp-support]
chat. You can also report spam there so our friendly operators log and blacklist it for you if you're not an agent yet.
[sp-support]: https://t.me/SpamProtectionSupport