add doc/gps-track.md

2 files changed, 35 insertions, 0 deletions

diff --git a/doc/gps-track.md b/doc/gps-track.md
new file mode 100644
index 0000000..a7b3d7f
--- /dev/null
+++ b/doc/gps-track.md
@@ -0,0 +1,34 @@
+Send GPS position to server
+===========================
+
+[◀ Go back to main README](../README.md)
+
+Description
+-----------
+
+This script is supposed to run periodically from scheduler and send GPS
+position data to a server for tracking.
+
+A hardware GPS antenna is required.
+
+Requirements and installation
+-----------------------------
+
+Just install the script:
+
+    $ScriptInstallUpdate gps-track;
+
+... and create a scheduler:
+
+    / system scheduler add interval=1m name=gps-track on-event="/ system script run gps-track;" start-time=startup;
+
+Configuration
+-------------
+
+The configuration goes to `global-config-overlay`, the only parameter is:
+
+* `GpsTrackUrl`: the url to send json data to
+
+---
+[◀ Go back to main README](../README.md)  
+[▲ Go back to top](#top)
diff --git a/gps-track b/gps-track
index 2513e03..4a27eb8 100644
--- a/gps-track
+++ b/gps-track
@@ -3,6 +3,7 @@
 # Copyright (c) 2018-2020 Christian Hesse <mail@eworm.de>
 #
 # track gps data by sending json data to http server
+# https://git.eworm.de/cgit/routeros-scripts/about/doc/gps-track.md
 
 :global GpsTrackUrl;
 :global Identity;