diff --git a/README.md b/README.md index 8704348..7331478 100644 --- a/README.md +++ b/README.md @@ -1 +1,29 @@ # Simple Bot Twitch en Python utilisant la librairie [TwitchIO](https://github.com/TwitchIO/TwitchIO). + +## Setup and Run + +Requires Python `3.9.5`. + +Install necessary packages: + +```bash +python3 -m pip install -r requirements.txt +``` + +Create `.env` file in `src` folder + +Open `.env` and insert the following fields: + +| Field | Explanation | +|----------------|-----------------------------------------------------------------------------------------------------------| +| `ACCESS_TOKEN` | Access token you can take [here](https://twitchtokengenerator.com/) (be sure you selected Bot Chat Token) | +| `PREFIX` | Prefix you want to use for your bot | +| `CHANNEL` | The name of the your Twitch channel you want the bot to run at | +| `DISCORD` | Link to your discord server | + +Start Bot: + +```bash +cd src +python3 main.py +```