Davte/bic_bot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Better instructions

Browse Source
This commit is contained in:
Davte 2021-06-20 01:05:26 +02:00
parent 2663f44339
commit 1b0acad7b4
Signed by: Davte
GPG Key ID: 209AE674A0007425
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -2,7 +2,14 @@
Breaking Italy Club bot Breaking Italy Club bot
## Instructions ## User manual
Basic users just need to follow these simple instructions.
* Start the bot and write `/email your_email@example.com`
* Click the verification link in the mail (also check the SPAM folder!)
* Wait for the invitation link. It will be available as soon as your patron status is verified by the staff
## Installation
This needs to be done only one time server-side.
* Get a Telegram bot API token ([@botfather](https://t.me/botfather)), allow groups and set the bot [group privacy](https://core.telegram.org/bots#privacy-mode) to off. * Get a Telegram bot API token ([@botfather](https://t.me/botfather)), allow groups and set the bot [group privacy](https://core.telegram.org/bots#privacy-mode) to off.
* Install bic_bot * Install bic_bot
```bash ```bash
@ -11,7 +18,7 @@ Breaking Italy Club bot
bash ./run_me.sh bash ./run_me.sh
``` ```
* Add the bot to the BIC chat as administrator * Add the bot to the BIC chat as administrator
* Write `/set_chat` in the chat * Write `/set_chat` in that chat
* Send the bot a csv file named "patrons.csv" with patrons' emails * Send the bot a csv file named "patrons.csv" with patrons' emails
``` ```
person@example.com, person@example.com,
@ -20,18 +27,12 @@ Breaking Italy Club bot
``` ```
The csv file must be sent periodically. The csv file must be sent periodically.
* [NOT YET IMPLEMENTED] Using Patreon's API, the patrons list will be automatically downloaded from the server * [NOT YET IMPLEMENTED] Using Patreon's API, the patrons list will be automatically downloaded from the server
* Users can link their email to their Telegram account automatically. A confirmation email will help to verify the association. When their email gets whitelisted, users are sent an invite link.
## Functioning ## Functioning
* Whenever a person joins the chat, the bot will check whether their Telegram account is linked to an email listed in the patrons list. If not, the user will be kicked out. * Whenever a person joins the chat, the bot will check whether their Telegram account is linked to an email listed in the patrons list. If not, the user will be kicked out.
* Whenever an email is removed from the white list, the linked Telegram account will be kicked out. * Whenever an email is removed from the white list, the linked Telegram account will be kicked out.
* Any user can automatically link their email to their Telegram account. If their email is white-listed, they can join the chat. * Any user can automatically link their email to their Telegram account. If their email is white-listed, they can join the chat.
## User manual
* Start the bot and write `/email your_email@example.com`
* Click the verification link in the mail (also check the SPAM folder!)
* Wait for the invitation link. It will be available as soon as your patron status is verified by the staff
## Credits ## Credits
This [davtelepot-based](https://gogs.davte.it/davte/davtelepot) bot has been developed by [@Davte](https://www.davte.it). This [davtelepot-based](https://gogs.davte.it/davte/davtelepot) bot has been developed by [@Davte](https://www.davte.it).
No official endorsement has been given by Breaking Italy. No official endorsement has been given by [Breaking Italy](http://breakingitaly.club) staff.