katja's git: oeffisearch

add README

diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+## Öffisearch
+Öffisearch is a progressive web app for querying public transport information for the DB (and others like RMV, BVG, nah.sh and more) networks. A hosted version of Öffisearch is available at [oeffi.katja.wtf](https://oeffi.katja.wtf).
+
+This version of Öffisearch is a hard fork of [TrainSearch](https://cyberchaos.dev/yuka/trainsearch) which in turn was based on the web-client of the nimlang based version of Öffisearch. The source of the old nimlang based version of Öffisearch can be found in the `old-nimlang` branch of this repo.
+
+### Development
+- Install `node` and `pnpm` from your distribution's package repositories.
+- Run `pnpm install` to fetch the needed dependencies.
+- Run `pnpm dev` to start a development server and rollup-watcher (which rebuilds the code on changes)
+
+Or `nix develop`, to set up the Öffisearch development server using the Nix package manager.
+
+### Attribution
+- Big thanks to [yuka](https://cyberchaos.dev/yuka) for building [TrainSearch](https://cyberchaos.dev/yuka/trainsearch)
+- Thanks a lot to the [Public Transport Project](https://github.com/public-transport) for their work on [hafas-client](https://github.com/public-transport/hafas-client/) and [db-vendo-client](https://github.com/public-transport/db-vendo-client/).
+- Also thanks to [marudor](https://github.com/marudor) for his great bahn.expert tool, from which we adopted the code to parse the coach-sequences and train-types.
+
+Without their work Öffisearch would not be possible!