db-rest/readme.md

# db-rest

**A clean REST API wrapping around the [Deutsche Bahn](https://en.wikipedia.org/wiki/Deutsche_Bahn) [API](https://github.com/derhuerst/db-hafas#db-hafas).**

[API Documentation](docs/index.md) | [Why?](docs/why.md)

![db-rest architecture diagram](https://rawgit.com/derhuerst/db-rest/db-rest/architecture.svg)

[![dependency status](https://img.shields.io/david/derhuerst/db-rest.svg)](https://david-dm.org/derhuerst/db-rest)
![ISC-licensed](https://img.shields.io/github/license/derhuerst/db-rest.svg)
[![gitter channel](https://badges.gitter.im/derhuerst/db-rest.svg)](https://gitter.im/derhuerst/db-rest)
[![support me on Patreon](https://img.shields.io/badge/support%20me-on%20patreon-fa7664.svg)](https://patreon.com/derhuerst)


## Installing

```
git clone https://github.com/derhuerst/db-rest.git
cd db-rest
npm install --production
npm start
```

[A Docker image is available as `derhuerst/db-rest`.](https://hub.docker.com/r/derhuerst/db-rest)


## Contributing

If you **have a question**, **found a bug** or want to **propose a feature**, have a look at [the issues page](https://github.com/derhuerst/db-rest/issues).