diff --git a/docs/changelog.md b/docs/changelog.md index 028445a1..dcefb19f 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -6,6 +6,7 @@ This version is not fully backwords-compatible. Check out [the migration guide]( ### new features ✨ +- 2d3796a BVG profile - 0db84ce #61 parse remarks for stopovers and journey legs - ac9819b `arrivals()` method – [docs](arrivals.md) - 5b754aa `refreshJourney()` method – [docs](refresh-journey.md) diff --git a/p/bvg/readme.md b/p/bvg/readme.md index 35b4b89a..0304acb2 100644 --- a/p/bvg/readme.md +++ b/p/bvg/readme.md @@ -1,22 +1,21 @@ -# VBB profile for `hafas-client` +# BVG profile for `hafas-client` -[*Verkehrsverbund Berlin-Brandenburg (VBB)*](https://en.wikipedia.org/wiki/Verkehrsverbund_Berlin-Brandenburg) is a group of public transport companies, running the public transport network in [Berlin](https://en.wikipedia.org/wiki/Berlin). This profile adds *VBB*-specific customizations to `hafas-client`. Consider using [`vbb-hafas`](https://github.com/derhuerst/vbb-hafas#vbb-hafas), to always get the customized client right away. +[*Verkehrsverbund Berlin-Brandenburg (BVG)*](https://en.wikipedia.org/wiki/Verkehrsverbund_Berlin-Brandenburg) is the major local transport provider in [Berlin](https://en.wikipedia.org/wiki/Berlin). This profile adds *BVG*-specific customizations to `hafas-client`. ## Usage ```js const createClient = require('hafas-client') -const vbbProfile = require('hafas-client/p/vbb') +const bvgProfile = require('hafas-client/p/bvg') -// create a client with VBB profile -const client = createClient(vbbProfile) +// create a client with BVG profile +const client = createClient(bvgProfile, 'my-awesome-program') ``` ## Customisations -- parses *VBB*-specific products (such as *X-Bus*) +- parses *BVG*-specific products (such as *X-Bus*) - strips parts from station names that are unnecessary in the Berlin context - parses line names to give more information (e.g. "Is it an express bus?") -- parses *VBB*-specific tickets - renames *Ringbahn* line names to contain `⟳` and `⟲` diff --git a/readme.md b/readme.md index bad03961..e972c704 100644 --- a/readme.md +++ b/readme.md @@ -6,6 +6,7 @@ HAFAS endpoint | wrapper library | docs | example code | source code ---------------|------------------|------|---------|------------ [Deutsche Bahn (DB)](https://en.wikipedia.org/wiki/Deutsche_Bahn) | [`db-hafas`](https://github.com/derhuerst/db-hafas) | [docs](p/db/readme.md) | [example code](p/db/example.js) | [src](p/db/index.js) [Berlin & Brandenburg public transport (VBB)](https://en.wikipedia.org/wiki/Verkehrsverbund_Berlin-Brandenburg) | [`vbb-hafas`](https://github.com/derhuerst/vbb-hafas) | [docs](p/vbb/readme.md) | [example code](p/vbb/example.js) | [src](p/vbb/index.js) +[Berlin public transport (BVG)](https://en.wikipedia.org/wiki/Berliner_Verkehrsbetriebe) | – | [docs](p/bvg/readme.md) | [example code](p/bvg/example.js) | [src](p/bvg/index.js) [Österreichische Bundesbahnen (ÖBB)](https://en.wikipedia.org/wiki/Austrian_Federal_Railways) | [`oebb-hafas`](https://github.com/juliuste/oebb-hafas) | [docs](p/oebb/readme.md) | [example code](p/oebb/example.js) | [src](p/oebb/index.js) [Nahverkehr Sachsen-Anhalt (NASA)](https://de.wikipedia.org/wiki/Nahverkehrsservice_Sachsen-Anhalt)/[INSA](https://insa.de) | [`insa-hafas`](https://github.com/derhuerst/insa-hafas) | [docs](p/insa/readme.md) | [example code](p/insa/example.js) | [src](p/insa/index.js) [Nahverkehrsverbund Schleswig-Holstein (NAH.SH)](https://de.wikipedia.org/wiki/Nahverkehrsverbund_Schleswig-Holstein) | [`nahsh-hafas`](https://github.com/juliuste/nahsh-hafas) | [docs](p/nahsh/readme.md) | [example code](p/nahsh/example.js) | [src](p/nahsh/index.js)