initial commit

README.md

@@ -0,0 +1,49 @@
+Custom RouterOS Scripts
+=======================
+
+[RouterOS](https://mikrotik.com/software) is the operating system developed
+by [MikroTik](https://mikrotik.com/aboutus) for networking tasks. This
+repository holds a number of [scripts](https://wiki.mikrotik.com/wiki/Manual:Scripting)
+to manage RouterOS devices or extend their functionality.
+
+*Use at your own risk*, pay attention to
+[license and warranty](#license-and-warranty)!
+
+Requirements
+------------
+
+This is a repository containing **custom** RouterOS scripts. These do depend
+on upstream project. Visit
+[RouterOS-Scripts](https://git.eworm.de/cgit/routeros-scripts/about/) and
+follow the instructions there for the basic installation and setup.
+
+Available scripts
+-----------------
+
+* [Hello World](doc/hello-world.md)
+
+License and warranty
+--------------------
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+[GNU General Public License](COPYING.md) for more details.
+
+Upstream
+--------
+
+URL:
+[GitHub.com](https://github.com/eworm-de/routeros-scripts-custom)
+
+Mirror:
+[eworm.de](https://git.eworm.de/cgit/routeros-scripts-custom/about/)
+[GitLab.com](https://gitlab.com/eworm-de/routeros-scripts-custom)
+
+---
+[⬆️ Go back to top](#top)