simono41/db-rest
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix journeys docs 📝

Browse source 
closes #3
This commit is contained in:
Jannis R 2018-05-22 22:34:34 +02:00
parent 14efd7ac6f
commit 09674c61e2
No known key found for this signature in database
GPG key ID: 0FE83946296A88A5
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/index.md
View file

@ -94,12 +94,18 @@ Output from [`require('db-hafas').journeys(…)`](https://github.com/derhuerst/d
- `from`: **Required.** Station ID (e.g. `008011162`). - `from`: **Required.** Station ID (e.g. `008011162`).
- `to`: **Required.** Station ID (e.g. `008011162`). - `to`: **Required.** Station ID (e.g. `008011162`).
## POI/address format ## POI format
- `from.latitude`/`to.latitude`: **Required.** Latitude (e.g. `52.543333`). - `from.latitude`/`to.latitude`: **Required.** Latitude (e.g. `52.543333`).
- `from.longitude`/`to.longitude`: **Required.** Longitude (e.g. `13.351686`). - `from.longitude`/`to.longitude`: **Required.** Longitude (e.g. `13.351686`).
- `from.name`/`to.name`: Name of the locality (e.g. `Atze Musiktheater`). - `from.name`/`to.name`: Name of the locality (e.g. `Atze Musiktheater`).
- `from.id`/`to.id`: POI ID (e.g. `991598902`). - `from.id`/`to.id`: **Required.** POI ID (e.g. `991598902`).
## address format
- `from.latitude`/`to.latitude`: **Required.** Latitude (e.g. `52.543333`).
- `from.longitude`/`to.longitude`: **Required.** Longitude (e.g. `13.351686`).
- `from.address`/`to.address`: **Required.** Address (e.g. `Voltastr. 17`).
## other parameters ## other parameters