Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README #21

Open
1 of 2 tasks
MartinDelille opened this issue Jul 22, 2018 · 1 comment
Open
1 of 2 tasks

Improve README #21

MartinDelille opened this issue Jul 22, 2018 · 1 comment
Labels
enhancement New feature or request feature-request Users' requests

Comments

@MartinDelille
Copy link
Contributor

MartinDelille commented Jul 22, 2018

  • The README.md should give basic information on how to get the bot running for non-python developer like me.
  • It also could link to an existing bot on Telegram using this codebase (add CoolPollBot link to readme #22).
@alvarogzp
Copy link
Owner

Hello @MartinDelille, you are completely right, the README file needs to be improved and those two points you mention are important.

I need to find time to document it properly, but in the meantime, you can find a working bot on https://t.me/CoolPollBot.
In case you want to launch your own instance, the bot is run by executing the run.sh script (or the main.py if you want to handle dependencies and updates manually).
Prior to running, you must configure the auth token and admin user. It is explained here (just create a config dir on the root directory of the repository, write the auth token to a file called auth_token inside the config dir, and write your user id to admin_user_id and admin_chat_id).

@alvarogzp alvarogzp added enhancement New feature or request feature-request Users' requests labels Jul 24, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request feature-request Users' requests
Projects
None yet
Development

No branches or pull requests

2 participants