aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md25
1 files changed, 20 insertions, 5 deletions
diff --git a/readme.md b/readme.md
index d558b62..fa2fcc6 100644
--- a/readme.md
+++ b/readme.md
@@ -1,12 +1,24 @@
# trein?
-dom python script die je met fcgiwrap en nginx kunt draaien op een server om
-een ical bestand te genereren die je laat weten wanneer de ns weer eens niet
-rijdt, maar dan rechtstreeks in je agenda!
+domme python scripts voor openbaar vervoer in nederland in je agenda
+
+`storingen` is een script die je met fcgiwrap en nginx kunt draaien op een
+server om een ical bestand te genereren die je laat weten wanneer de ns weer
+eens niet rijdt
+
+`autoplanner` neemt een icalendar bestand in (met bijvoorbeeld een rooster), en
+vraagt voor elke dag een reisadvies op om bij de vroegste afspraak op tijd te
+zijn
## setup
-de API key wordt lekker veilig opgeslagen in een plain-text bestand `key`.
+### storingen
+
+de storingen API heeft helaas een API key nodig, maar gelukkig wordt deze
+lekker veilig opgeslagen in een plain-text bestand `storingen.key`.
+
+trajectnamen staan op losse regels in `storingen.cfg`, een voorbeeld hiervan
+staat in deze repository.
hier is een voorbeeld nginx configuratie (snippet die in een server block kan):
@@ -16,7 +28,10 @@ location /ical/trein.ics {
autoindex on;
fastcgi_pass unix:/var/run/fcgiwrap.socket;
include /etc/nginx/fastcgi_params;
- fastcgi_param SCRIPT_FILENAME /var/trein/fcgi;
+ fastcgi_param SCRIPT_FILENAME /var/trein/storingen.fcgi;
}
```
+### autoplanner
+
+WIP