From 7653f557caa5b22d8e9477dfee6d483793fe52fc Mon Sep 17 00:00:00 2001 From: Knut Ahlers Date: Wed, 5 Jan 2022 18:17:07 +0100 Subject: [PATCH] [docs] Update README Signed-off-by: Knut Ahlers --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 30f6796..87d1f1d 100644 --- a/README.md +++ b/README.md @@ -17,18 +17,19 @@ Please see the [Wiki](https://github.com/Luzifer/twitch-bot/wiki) for documentat ```console # twitch-bot --help Usage of twitch-bot: - --base-url string External URL of the config-editor interface (set to enable EventSub support) - --command-timeout duration Timeout for command execution (default 30s) - -c, --config string Location of configuration file (default "./config.yaml") - --log-level string Log level (debug, info, warn, error, fatal) (default "info") - --plugin-dir string Where to find and load plugins (default "/usr/lib/twitch-bot") - --rate-limit duration How often to send a message (default: 20/30s=1500ms, if your bot is mod everywhere: 100/30s=300ms, different for known/verified bots) (default 1.5s) - --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 - -v, --validate-config Loads the config, logs any errors and quits with status 0 on success - --version Prints current version and exits - + --base-url string External URL of the config-editor interface (set to enable EventSub support) + --command-timeout duration Timeout for command execution (default 30s) + -c, --config string Location of configuration file (default "./config.yaml") + --log-level string Log level (debug, info, warn, error, fatal) (default "info") + --plugin-dir string Where to find and load plugins (default "/usr/lib/twitch-bot") + --rate-limit duration How often to send a message (default: 20/30s=1500ms, if your bot is mod everywhere: 100/30s=300ms, different for known/verified bots) (default 1.5s) + --storage-encryption-pass string Passphrase to encrypt secrets inside storage (defaults to twitch-client:twitch-client-secret) + --storage-file string Where to store the data (default "./storage.json.gz") + --twitch-client string Client ID to act as + --twitch-client-secret string Secret for the Client ID + --twitch-token string OAuth token valid for client (fallback if no token was set in interface) + -v, --validate-config Loads the config, logs any errors and quits with status 0 on success + --version Prints current version and exits # twitch-bot help Supported sub-commands are: actor-docs Generate markdown documentation for available actors