From 09674c61e2a16854a7de88a5ace69abeeb92b3aa Mon Sep 17 00:00:00 2001 From: Jannis R Date: Tue, 22 May 2018 22:34:34 +0200 Subject: [PATCH] fix journeys docs :memo: closes #3 --- docs/index.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 1581212..5fd7822 100644 --- a/docs/index.md +++ b/docs/index.md @@ -94,12 +94,18 @@ Output from [`require('db-hafas').journeys(…)`](https://github.com/derhuerst/d - `from`: **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.longitude`/`to.longitude`: **Required.** Longitude (e.g. `13.351686`). - `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