Add README

README.md

@@ -0,0 +1,25 @@
+# Traveldrafter
+
+Keep track over multiple different connections while traveling trains.
+
+## Run
+
+```
+nix run git+https://git.clerie.de/clerie/traveldrafter.git
+```
+
+The web frontend is served under <https://localhost:3000/>.
+
+In production you probably would want to serve dir `web` directory as the service root from a webserver like nginx directly and only proxy the `api` route to the application.
+
+## Development
+
+Pass the path to the directory of the frontend scripts as `WEBDIR` environemnt var.
+
+```
+git clone https://git.clerie.de/clerie/traveldrafter.git
+
+cd traveldrafter
+
+WEBDIR=web nix run
+```