summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d61927d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# db-wagenreihung-to-json - Convert wagon order PDFs to JSON
+
+db-wagenreihung-to-json converts a wagon order (“Zugbildungsplan”) PDF obtained
+from
+[data.deutschebahn.com](https://data.deutschebahn.com/dataset/zugbildungsplanzugbildungsplan-zpar)
+to JSON. At the moment, conversion is limited to a map of train numbers to
+IC/ICE types (ICE 1, ICE 3, ICE 3 Redesign, ...). Train composition, exceptions
+on certain dates and other details are lost.
+
+The latest JSON produced by d-wagenreihung-to-json is available online at
+[dbdb/ice\_type.json](https://lib.finalrewind.org/dbdb/ice_type.json).