From 644eb07404d89b438d7f1fa0e8d0eef23323cf09 Mon Sep 17 00:00:00 2001 From: Knut Ahlers Date: Sun, 25 Jul 2021 14:33:17 +0200 Subject: [PATCH] Wiki: Add general info how to set up the config Signed-off-by: Knut Ahlers --- wiki/Home.md | 18 +++++++++++++++++- wiki/Home.md.tpl | 18 +++++++++++++++++- 2 files changed, 34 insertions(+), 2 deletions(-) diff --git a/wiki/Home.md b/wiki/Home.md index f4ccecf..c90f613 100644 --- a/wiki/Home.md +++ b/wiki/Home.md @@ -1,6 +1,22 @@ +# Config format + +```yaml +--- + +bot_token: '...' +guild_id: '...' + +module_configs: + - type: module-type + attributes: + key: value + +... +``` + # Modules -## schedule +## Type: `schedule` Posts stream schedule derived from Twitch schedule as embed in Discord channel diff --git a/wiki/Home.md.tpl b/wiki/Home.md.tpl index a828f51..bfd79e9 100644 --- a/wiki/Home.md.tpl +++ b/wiki/Home.md.tpl @@ -1,7 +1,23 @@ +# Config format + +```yaml +--- + +bot_token: '...' +guild_id: '...' + +module_configs: + - type: module-type + attributes: + key: value + +... +``` + # Modules {% for module in modules -%} -## {{ module.type }} +## Type: `{{ module.type }}` {{ module.description }}