Skip to content

Commit

Permalink
minor docs improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
derhuerst committed Jan 5, 2018
1 parent 508ff9f commit 951c26c
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/departures.md
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down
2 changes: 1 addition & 1 deletion docs/journey-leg.md
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down
2 changes: 1 addition & 1 deletion docs/journeys.md
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down
2 changes: 1 addition & 1 deletion docs/locations.md
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down
2 changes: 1 addition & 1 deletion docs/nearby.md
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down
2 changes: 1 addition & 1 deletion docs/radar.md
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down
8 changes: 4 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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
Expand Down

0 comments on commit 951c26c

Please sign in to comment.