add doc/capsman-rolling-upgrade.md

2 files changed, 40 insertions, 0 deletions

diff --git a/capsman-rolling-upgrade b/capsman-rolling-upgrade
index cedfc47..38843e6 100644
--- a/capsman-rolling-upgrade
+++ b/capsman-rolling-upgrade
@@ -4,6 +4,7 @@
 #                         Michael Gisbers <michael@gisbers.de>
 #
 # upgrade CAPs one after another
+# https://git.eworm.de/cgit/routeros-scripts/about/doc/capsman-rolling-upgrade.md
 
 :global ScriptLock;
 
diff --git a/doc/capsman-rolling-upgrade.md b/doc/capsman-rolling-upgrade.md
new file mode 100644
index 0000000..e78c87a
--- /dev/null
+++ b/doc/capsman-rolling-upgrade.md
@@ -0,0 +1,39 @@
+Run rolling CAP upgrades from CAPsMAN
+=====================================
+
+[◀ Go back to main README](../README.md)
+
+Description
+-----------
+
+CAPsMAN can upgrate CAP devices. This script runs a rolling upgrade for
+out-of-date CAP devices. The idea is to have just a fraction of devices
+reboot at a time, having the others to serve wireless connectivity.
+
+
+Requirements and installation
+-----------------------------
+
+Just install the script:
+
+    $ScriptInstallUpdate capsman-rolling-upgrade;
+
+Usage and invocation
+--------------------
+
+This script is intended as an add-on to
+[capsman-download-packages](capsman-download-packages.md), being invoked by
+that script when required.
+
+Alternatively run it manually:
+
+    / system script run capsman-rolling-upgrade;
+
+See also
+--------
+
+* [Download packages for CAP upgrade from CAPsMAN](capsman-download-packages.md)
+
+---
+[◀ Go back to main README](../README.md)  
+[▲ Go back to top](#top)