db-vendo-client/p/vbb/readme.md
2023-03-14 20:58:17 +01:00

21 lines
900 B
Markdown

# VBB 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.
## Usage
```js
import {createClient} from 'hafas-client'
import {profile as vbbProfile} from 'hafas-client/p/vbb/index.js'
const userAgent = 'link-to-your-project-or-email' // adapt this to your project!
// create a client with VBB profile
const client = createClient(vbbProfile, userAgent)
```
## Customisations
- parses *VBB*-specific products (such as *X-Bus*)
- renames *Ringbahn* line names to contain `⟳` and `⟲`