luzifer/twitch-bot
1
0
Fork 0
mirror of https://github.com/Luzifer/twitch-bot.git synced 2024-12-20 20:01:17 +00:00
Code Issues Projects Releases Wiki Activity

Add documentation hint

Browse source 
Signed-off-by: Knut Ahlers <knut@ahlers.me>
This commit is contained in:
Knut Ahlers 2020-12-24 15:47:42 +01:00
parent 914f0a8a24
commit bdd47377bc
Signed by: luzifer
GPG key ID: 0066F03ED215AD7D
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -9,3 +9,18 @@
Twitch-Bot is intended as an alternative to having a bot managed by Streamlabs or Streamelements and therefore having more control over it, the availability and how it works. Twitch-Bot is intended as an alternative to having a bot managed by Streamlabs or Streamelements and therefore having more control over it, the availability and how it works.
At the moment it is a work-in-progress and does not yet implment all features it shall in the future. At the moment it is a work-in-progress and does not yet implment all features it shall in the future.
## Configuration
Please see the [Wiki](https://github.com/Luzifer/twitch-bot/wiki) for documentation of the configuration file.
```console
# twitch-bot --help
Usage of twitch-bot:
-c, --config string Location of configuration file (default "./config.yaml")
--log-level string Log level (debug, info, warn, error, fatal) (default "info")
--storage-file string Where to store the data (default "./storage.json.gz")
--twitch-client string Client ID to act as
--twitch-token string OAuth token valid for client
--version Prints current version and exits
```