initial commit

1 files changed, 42 insertions, 0 deletions

diff --git a/doc/hello-world.md b/doc/hello-world.md
new file mode 100644
index 0000000..a9be755
--- /dev/null
+++ b/doc/hello-world.md
@@ -0,0 +1,42 @@
+Hello World
+===========
+
+[⬅️ Go back to main README](../README.md)
+
+> ℹ️ **Info**: This script can not be used on its own but requires the base
+> installation. See [main README](../README.md) for details.
+
+Description
+----------- 
+
+This is a demo script. Invoked from terminal it writes to system log and
+terminal, or sends a notification otherwise.
+
+Requirements and installation
+----------------------------- 
+
+Just install the script:
+
+    $ScriptInstallUpdate hello-world.rsc "base-url=https://git.eworm.de/cgit/routeros-scripts-custom/plain/"
+
+Configuration
+-------------
+
+There's no specific configuration in `global-config-overlay`, other than
+general configuration for notifications.
+
+Usage and invocation
+-------------------- 
+
+Just run the script:
+
+    /system/script/run hello-world.rsc;
+
+See also 
+--------
+
+* ...
+
+--- 
+[⬅️ Go back to main README](../README.md)  
+[⬆️ Go back to top](#top)