Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
geertw committed May 21, 2019
1 parent 1331193 commit 5ef1c1b
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ GoTrain is a server application for receiving, processing and distributing
real-time data about train services in the Netherlands.

GoTrain is designed to continuously receive data streams offered as open data
by the Dutch Railways ([NS](http://www.ns.nl/)). The data is processed and
by the [Dutch Railways (NS)](http://www.ns.nl/). The data is processed and
saved in-memory in order to offer a very fast REST API, which can be used by
numerous clients to show live information about train departures, arrivals etc.

Expand All @@ -30,11 +30,26 @@ to:
It is easy to extend GoTrain's functionality or to build your own applications
using the REST API. For example; create your live departures board.

Development roadmap
-------------------

The main objectives for GoTrain have now been developed, but there is a roadmap
for further development. The main planned improvements are:

* Documentation - document the REST API and the setup process
* Increase test coverage - the API is currently not tested
* Better monitoring tools - analyze the data streams, monitor for errors, etc.
* Archive functionality - allow to store all data to an archive for further
processing or analysis at a later time

Status
------

GoTrain is currently **under development** and is not yet used for production
workloads.
GoTrain is currently being used in production by
[Rijden de Treinen](https://www.rijdendetreinen.nl/) as a source for realtime
departure times, arrivals and for trip details, both on the website and in the
mobile app. Please let it known when you use GoTrain for a cool project, a big
application or for some other purpose!

License
-------
Expand Down

0 comments on commit 5ef1c1b

Please sign in to comment.