README: installing custom scripts & modules

3 files changed, 26 insertions, 0 deletions

diff --git a/README.d/12-install-custom-script.avif b/README.d/12-install-custom-script.avif
new file mode 100644
index 0000000..fb53606
--- /dev/null
+++ b/README.d/12-install-custom-script.avif
diff --git a/README.d/hello-world.rsc b/README.d/hello-world.rsc
new file mode 100644
index 0000000..17ec575
--- /dev/null
+++ b/README.d/hello-world.rsc
@@ -0,0 +1,3 @@
+#!rsc by RouterOS
+
+:put ("Hello World from " . [ / system identity get name ] . "!");
diff --git a/README.md b/README.md
index 361dbd5..23d1254 100644
--- a/README.md
+++ b/README.md
@@ -231,6 +231,29 @@ Available modules
 * [Send notifications via Telegram](doc/mod/notification-telegram.md)
 * [Download script and run it once](doc/mod/scriptrunonce.md)
 
+Installing custom scripts & modules
+-----------------------------------
+
+My scripts cover a lot of use cases, but you may have your own ones. You can
+still use my scripts to manage and deploy yours, by specifying `base-url`
+(and `url-suffix`) for each script.
+
+This will fetch and install a script `hello-world.rsc` from the given url:
+
+    $ScriptInstallUpdate hello-world.rsc "base-url=https://git.eworm.de/cgit/routeros-scripts/plain/README.d/"
+
+![screenshot: install custom script](README.d/12-install-custom-script.avif)
+
+(Yes, the example url still belongs to the repository for easy
+handling - but the url can be what ever you use.)
+
+For a script to be considered valid it has to begin with a *magic token*.
+Have a look at [any script](README.d/hello-world.rsc) and copy the first line
+without modification.
+
+Starting a script's name with `mod/` makes it a module and it is run
+automatically by `global-functions`.
+
 Contact
 -------