summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0e8a224
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# db-fahrzeuglexikon-parser
+
+db-fahrzeuglexikon-parser extracts PNG/SVG wagon images and accompanying JSON
+data for DB long-distance carriages from a Fahrzeuglexikon PDF obtained from
+[data.deutschebahn.com](https://data.deutschebahn.com/dataset/fahrzeuglexikon).
+
+## Online Services
+
+The latest JSON, PNG, and SVG output produced by db-fahrzeuglexikon-parser is
+available online at
+[dbdb/db\_wagen](https://lib.finalrewind.org/dbdb/db_wagen/).
+
+Both Fahrzeuglexikon PDF and generated PNG/SVG/JSON files are Open Data.
+
+* [DB Fahrzeuglexikon License](https://data.deutschebahn.com/dataset/fahrzeuglexikon)
+* [PNG/SVG/JSON License](https://lib.finalrewind.org/dbdb/db_wagen/COPYING)