path: root/README
diff options
authorRobin Krahl <me@robin-krahl.de>2016-02-26 01:40:47 +0100
committerRobin Krahl <me@robin-krahl.de>2016-02-26 01:40:47 +0100
commit745c643c2f900c8efeb0ac0a8ea3a519b3a790ac (patch)
tree1cd84b4666b1ba13b5d81699cc940db52c1f6ee8 /README
initial commit
Diffstat (limited to 'README')
1 files changed, 40 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..ef0ee05
--- /dev/null
+++ b/README
@@ -0,0 +1,40 @@
+dbfp -- DB timetable API
+This C library provides an interface to the timetable API of the Deutsche Bahn
+(*Fahrplan-API*). This API exposes information on stations, departures,
+arrivals and routes.
+Compiling and installation
+Build dbfp with `make`. You can run the test suite with `make check`.
+The DB timetable API was released on February 25th, 2016. At the moment, you
+need an API key to access the data. For more information on the API, have a
+look at the [API description][api] and at the [technical documentation][doc].
+Bugs and hacking
+If you encouter a bug or if you want to contribute to dbfp, please send an
+email to <dbfp-dev@ireas.org>.
+The library is published under the terms of the MIT/X11 license (see LICENSE).
+The timetable data is published under the terms of the [Creative Commons
+Attribution 4.0 International license][cc-by-sa-4.0].
+[api]: http://data.deutschebahn.com/apis/fahrplan/
+[doc]: http://data.deutschebahn.com/apis/fahrplan/Fpl-API-Doku-Open-Data-BETA-0_81.pdf
+[cc-by-sa-4.0]: https://creativecommons.org/licenses/by/4.0/