From fe4ef6f2fcd0d3c8b5ff66d384c9d0d9195f8520 Mon Sep 17 00:00:00 2001
From: Knut Ahlers <knut@ahlers.me>
Date: Wed, 26 May 2021 14:00:21 +0200
Subject: [PATCH] Update Wiki for new mechanics

Signed-off-by: Knut Ahlers <knut@ahlers.me>
---
 wiki/Home.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/wiki/Home.md b/wiki/Home.md
index ec1ee30..5500fa4 100644
--- a/wiki/Home.md
+++ b/wiki/Home.md
@@ -12,6 +12,13 @@ permit_allow_moderator: true
 # How long to permit on !permit command
 permit_timeout: 60s
 
+# Variables are made available in templating (for example useful to disable several
+# rules at once using the `disable_on_template` directive)
+# Supported data types: Boolean, Float, Integer, String
+variables:
+  myvariable: true
+  anothervariable: "string"
+
 auto_messages:
   - channel: 'mychannel'          # String, channel to send message to
     message: 'Automated message'  # String, message to send
@@ -24,6 +31,9 @@ auto_messages:
 
     only_on_live: true    # Boolean, optional, only send the message when channel is live
 
+    # Disable message using templating, must yield string `true` to disable the automated message
+    disable_on_template: '{{ ne .myvariable true }}'
+
 rules: # See below for examples
 
   - actions: # Array of actions to take when this rule matches
@@ -61,12 +71,18 @@ rules: # See below for examples
     # Do not apply cooldown for these badges
     skip_cooldown_for: [broadcaster, moderator]
 
+    # Disable the rule by setting to true
+    disable: false
+
     # Disable actions when the matched channel has no active stream
     disable_on_offline: false
 
     # Disable actions on this rule if the user has an active permit
     disable_on_permit: false
 
+    # Disable actions using templating, must yield string `true` to disable the rule
+    disable_on_template: '{{ ne .myvariable true }}'
+
     # Disable actions on this rule if the user has one of these badges
     disable_on: [broadcaster, moderator]