Improve readme

This commit is contained in:
JerryXiao 2018-12-20 13:14:49 +08:00
parent e2ff08d1fb
commit 48e47fd41c
Signed by: Jerry
GPG key ID: 9D9CE43650FF2BAA

View file

@ -3,11 +3,11 @@
This user bot can play uno with other humans. (Python3 only)
## Telethon
## Installation
The bot uses [Telethon](https://github.com/LonamiWebs/Telethon), a Pure Python 3 MTProto API Telegram client library.
Please follow [this](https://telethon.readthedocs.io/en/stable/extra/basic/installation.html#installation) guide to install Telethon, and [create your api id and hash](https://telethon.readthedocs.io/en/stable/extra/basic/creating-a-client.html).
Then place your settings in config.py.
Run the bot with python3 bot.py.
Then place your settings in `config.py`.
Run the bot with `python3 bot.py` or `./bot.py`.
## Contributing
* Copyright © 2018 JerryXiao