diff --git a/README.md b/README.md index bf352f3..b9f9025 100644 --- a/README.md +++ b/README.md @@ -12,19 +12,25 @@ Breaking Italy Club bot ``` * Add the bot to the BIC chat as administrator * Write `/set_chat` in the chat -* Send a csv file to the bot named "patrons.csv" with patreons emails +* Send the bot a csv file named "patrons.csv" with patrons' emails ``` person@example.com, someone@gmail.com, [...] ``` + 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] Users will be able to link their email to their Telegram account automatically. A confirmation email will help to verify the association +* 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 * 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. -* [NOT YET IMPLEMENTED] 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 This [davtelepot-based](https://gogs.davte.it/davte/davtelepot) bot has been developed by [@Davte](https://www.davte.it).