From bdd47377bc7bec9d99771c6c66ed9ad09b894ef7 Mon Sep 17 00:00:00 2001 From: Knut Ahlers Date: Thu, 24 Dec 2020 15:47:42 +0100 Subject: [PATCH] Add documentation hint Signed-off-by: Knut Ahlers --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 1c0e611..8a9df91 100644 --- a/README.md +++ b/README.md @@ -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. 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 +```