aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/readme.md b/readme.md
index fa2fcc6..c38542f 100644
--- a/readme.md
+++ b/readme.md
@@ -34,4 +34,16 @@ location /ical/trein.ics {
### autoplanner
-WIP
+deze gebruikt de openbare reisplanner om reisadvies op te vragen. omdat deze
+methode van de NS api gebruiken niet officieel ondersteund is kan deze mogelijk
+ooit stoppen met werken.
+
+dit script verwacht een bestand `autoplanner.json`, die gebaseerd is op
+`autoplanner.def.json`, en leest een icalendar agenda vanaf stdin.
+
+voorbeeldaanroep:
+
+```bash
+./autoplanner.py < rooster.ics
+```
+