diff --git a/docs/departures.md b/docs/departures.md index b0217f14..60756dde 100644 --- a/docs/departures.md +++ b/docs/departures.md @@ -35,7 +35,7 @@ With `opt`, you can override the default options, which look like this: You may pass the `journeyId` field into [`journeyLeg(ref, lineName, [opt])`](journey-leg.md) to get details on the vehicle's journey. -As an example, we're going to use the VBB profile: +As an example, we're going to use the [VBB profile](../p/vbb): ```js const createClient = require('hafas-client') diff --git a/docs/journey-leg.md b/docs/journey-leg.md index 9538199f..b5f24afe 100644 --- a/docs/journey-leg.md +++ b/docs/journey-leg.md @@ -33,7 +33,7 @@ With `opt`, you can override the default options, which look like this: *Note:* As stated in the [*Friendly Public Transport Format* `1.0.1`](https://github.com/public-transport/friendly-public-transport-format/tree/1.0.1), the returned `departure` and `arrival` times include the current delay. The `departureDelay`/`arrivalDelay` fields express how much they differ from the schedule. -As an example, we're going to use the VBB profile: +As an example, we're going to use the [VBB profile](../p/vbb): ```js const createClient = require('hafas-client') diff --git a/docs/journeys.md b/docs/journeys.md index 47ec0c9e..3aa30ae2 100644 --- a/docs/journeys.md +++ b/docs/journeys.md @@ -65,7 +65,7 @@ With `opt`, you can override the default options, which look like this: *Note:* As stated in the [*Friendly Public Transport Format* `1.0.1`](https://github.com/public-transport/friendly-public-transport-format/tree/1.0.1), the returned `departure` and `arrival` times include the current delay. The `departureDelay`/`arrivalDelay` fields express how much they differ from the schedule. -As an example, we're going to use the VBB profile: +As an example, we're going to use the [VBB profile](../p/vbb): ```js const createClient = require('hafas-client') diff --git a/docs/locations.md b/docs/locations.md index 6f8b439d..8b9d17ab 100644 --- a/docs/locations.md +++ b/docs/locations.md @@ -16,7 +16,7 @@ With `opt`, you can override the default options, which look like this: ## Response -As an example, we're going to use the VBB profile: +As an example, we're going to use the [VBB profile](../p/vbb): ```js const createClient = require('hafas-client') diff --git a/docs/nearby.md b/docs/nearby.md index 3424e281..397162f0 100644 --- a/docs/nearby.md +++ b/docs/nearby.md @@ -16,7 +16,7 @@ With `opt`, you can override the default options, which look like this: ## Response -As an example, we're going to use the VBB profile: +As an example, we're going to use the [VBB profile](../p/vbb): ```js const createClient = require('hafas-client') diff --git a/docs/radar.md b/docs/radar.md index 4db46136..b1be3bfa 100644 --- a/docs/radar.md +++ b/docs/radar.md @@ -18,7 +18,7 @@ With `opt`, you can override the default options, which look like this: *Note:* As stated in the [*Friendly Public Transport Format* `1.0.1`](https://github.com/public-transport/friendly-public-transport-format/tree/1.0.1), the returned `departure` and `arrival` times include the current delay. The `departureDelay`/`arrivalDelay` fields express how much they differ from the schedule. -As an example, we're going to use the VBB profile: +As an example, we're going to use the [VBB profile](../p/vbb): ```js const createClient = require('hafas-client') diff --git a/readme.md b/readme.md index e957243a..14f941be 100644 --- a/readme.md +++ b/readme.md @@ -2,8 +2,8 @@ **A client for HAFAS public transport APIs**. Sort of like [public-transport-enabler](https://github.com/schildbach/public-transport-enabler), but with a smaller scope. It also [contains customisations](p) for the following transport networks: -- [Deutsche Bahn](https://en.wikipedia.org/wiki/Deutsche_Bahn) - [docs](p/db/readme.md) – [usage example](p/db/example.js) – [src](p/db/index.js) -- [Berlin public transport](https://en.wikipedia.org/wiki/Verkehrsverbund_Berlin-Brandenburg) - [docs](p/vbb/readme.md) – [usage example](p/vbb/example.js) – [src](p/vbb/index.js) +- [Deutsche Bahn](https://en.wikipedia.org/wiki/Deutsche_Bahn) – [docs](p/db/readme.md) – [usage example](p/db/example.js) – [src](p/db/index.js) +- [Berlin public transport](https://en.wikipedia.org/wiki/Verkehrsverbund_Berlin-Brandenburg) – [docs](p/vbb/readme.md) – [usage example](p/vbb/example.js) – [src](p/vbb/index.js) [![npm version](https://img.shields.io/npm/v/hafas-client.svg)](https://www.npmjs.com/package/hafas-client) [![build status](https://img.shields.io/travis/derhuerst/hafas-client.svg)](https://travis-ci.org/derhuerst/hafas-client) @@ -13,9 +13,9 @@ ## Background -There's [a company called HaCon](http://hacon.de) that sells [a public transport management system called HAFAS](https://de.wikipedia.org/wiki/HAFAS). It is [used by companies all over Europe](https://gist.github.com/derhuerst/2b7ed83bfa5f115125a5) to serve routing and departure information for apps. All those endpoints are similar, with the same terms and API routes, but have slightly different options, filters and enable features. +There's [a company called HaCon](http://hacon.de) that sells [a public transport management system called HAFAS](https://de.wikipedia.org/wiki/HAFAS). It is [used by companies all over Europe](https://gist.github.com/derhuerst/2b7ed83bfa5f115125a5) to serve routing and departure information for apps. All those endpoints are similar, with the same terms and API routes, but have slightly different options, filters and sets of enabled features. -`hafas-client` contains all logic for communicating with these, as well as serialising from and parsing to [*Friendly Public Transport Format (FPTF)* `1.0.1`](https://github.com/public-transport/friendly-public-transport-format/blob/1.0.1/spec/readme.md). Endpoint-specific customisations (called "profiles" here) increase the quality of the returned data. +`hafas-client` contains all logic for communicating with these, as well as serialising from and parsing to [*Friendly Public Transport Format (FPTF)* `1.0.1`](https://github.com/public-transport/friendly-public-transport-format/blob/1.0.1/spec/readme.md). Endpoint-specific customisations (called *profiles* here) increase the quality of the returned data. ## Installing