From 5594ffd69afb9b72e73a62103cd657d51d4b0366 Mon Sep 17 00:00:00 2001
From: Christian Hesse <mail@eworm.de>
Date: Fri, 27 Mar 2020 21:48:25 +0100
Subject: add doc/mode-button.md

---
 doc/mode-button.md    | 40 ++++++++++++++++++++++++++++++++++++++++
 mode-button-event     |  1 +
 mode-button-scheduler |  1 +
 3 files changed, 42 insertions(+)
 create mode 100644 doc/mode-button.md

diff --git a/doc/mode-button.md b/doc/mode-button.md
new file mode 100644
index 0000000..5018d6e
--- /dev/null
+++ b/doc/mode-button.md
@@ -0,0 +1,40 @@
+Mode botton with multiple presses
+=================================
+
+[◀ Go back to main README](../README.md)
+
+Description
+-----------
+
+These scripts extend the functionality of mode button. Instead of just one
+you can trigger several actions by pressing the mode button several times.
+
+The hardware needs to have a mode button, see
+`/ system routerboard mode-button`.
+
+Requirements and installation
+-----------------------------
+
+Just install the scripts:
+
+    $ScriptInstallUpdate mode-button-event,mode-button-scheduler;
+
+Then configure the mode-button to run `mode-button-event`:
+
+    / system routerboard mode-button set enabled=yes on-event="/ system script run mode-button-event;";
+
+Configuration
+-------------
+
+The configuration goes to `global-config-overlay`, the only parameter is:
+
+* `ModeButton`: an array with defined actions
+
+Usage and invocation
+--------------------
+
+Press the mode button. :)
+
+---
+[◀ Go back to main README](../README.md)  
+[▲ Go back to top](#top)
diff --git a/mode-button-event b/mode-button-event
index 91b0edb..4768e09 100644
--- a/mode-button-event
+++ b/mode-button-event
@@ -3,6 +3,7 @@
 # Copyright (c) 2018-2020 Christian Hesse <mail@eworm.de>
 #
 # run on mode-button event and count button presses
+# https://git.eworm.de/cgit/routeros-scripts/about/doc/mode-button.md
 
 :global ModeButton;
 
diff --git a/mode-button-scheduler b/mode-button-scheduler
index 2b6f083..03f673b 100644
--- a/mode-button-scheduler
+++ b/mode-button-scheduler
@@ -3,6 +3,7 @@
 # Copyright (c) 2018-2020 Christian Hesse <mail@eworm.de>
 #
 # act on multiple mode-botton presses from scheduler
+# https://git.eworm.de/cgit/routeros-scripts/about/doc/mode-button.md
 
 :global ModeButton;
 
-- 
cgit v1.2.3-54-g00ecf