kbruen/db-vendo-client
1
0
Fork 0
mirror of https://github.com/public-transport/db-vendo-client.git synced 2025-02-23 23:29:35 +02:00
Code Issues Projects Releases Packages 1 Wiki Activity Actions

docs: move list of methods to docs/index.md 📝

Browse source
This commit is contained in:
Jannis R 2018-03-14 20:46:10 +01:00
parent 6e61097687
commit beb58b4bf0
No known key found for this signature in database
GPG key ID: 0FE83946296A88A5
2 changed files with 10 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/index.md Normal file
View file

@ -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

8
readme.md
View file

@ -32,13 +32,7 @@ npm install hafas-client
## API ## API
- [`journeys(from, to, [opt])`](docs/journeys.md) – get journeys between locations [API documentation](docs/index.md)
- [`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
## Usage ## Usage