From beb58b4bf08266e296d4f373f9a24272691c31c6 Mon Sep 17 00:00:00 2001 From: Jannis R Date: Wed, 14 Mar 2018 20:46:10 +0100 Subject: [PATCH] docs: move list of methods to docs/index.md :memo: --- docs/index.md | 9 +++++++++ readme.md | 8 +------- 2 files changed, 10 insertions(+), 7 deletions(-) create mode 100644 docs/index.md diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..574a0c98 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,9 @@ +# API documentation + +- [`journeys(from, to, [opt])`](journeys.md) – get journeys between locations +- [`journeyLeg(ref, lineName, [opt])`](journey-leg.md) – get details for a leg of a journey +- [`departures(station, [opt])`](departures.md) – query the next departures at a station +- [`locations(query, [opt])`](locations.md) – find stations, POIs and addresses +- [`location(id)`](location.md) – get details about a location +- [`nearby(location, [opt])`](nearby.md) – show stations & POIs around +- [`radar(north, west, south, east, [opt])`](radar.md) – find all vehicles currently in a certain area diff --git a/readme.md b/readme.md index d627004a..4bcfe31a 100644 --- a/readme.md +++ b/readme.md @@ -32,13 +32,7 @@ npm install hafas-client ## API -- [`journeys(from, to, [opt])`](docs/journeys.md) – get journeys between locations -- [`journeyLeg(ref, lineName, [opt])`](docs/journey-leg.md) – get details for a leg of a journey -- [`departures(station, [opt])`](docs/departures.md) – query the next departures at a station -- [`locations(query, [opt])`](docs/locations.md) – find stations, POIs and addresses -- [`location(id)`](docs/location.md) – get details about a location -- [`nearby(location, [opt])`](docs/nearby.md) – show stations & POIs around -- [`radar(north, west, south, east, [opt])`](docs/radar.md) – find all vehicles currently in a certain area +[API documentation](docs/index.md) ## Usage