From 2ae8fd2ba0e87ea84e3b51563b00fb14f01d9914 Mon Sep 17 00:00:00 2001
From: Jannis R <mail@jannisr.de>
Date: Sun, 17 Dec 2017 17:42:50 +0100
Subject: [PATCH] docs for VBB profile

---
 p/vbb/readme.md | 22 ++++++++++++++++++++++
 readme.md       |  4 ++--
 2 files changed, 24 insertions(+), 2 deletions(-)
 create mode 100644 p/vbb/readme.md

diff --git a/p/vbb/readme.md b/p/vbb/readme.md
new file mode 100644
index 00000000..a3ff3d1c
--- /dev/null
+++ b/p/vbb/readme.md
@@ -0,0 +1,22 @@
+# 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`.
+
+## Usage
+
+```js
+const createClient = require('hafas-client')
+const vbbProfile = require('hafas-client/p/vbb')
+
+// create a client with VBB profile
+const client = createClient(vbbProfile)
+```
+
+
+## Customisations
+
+- parses *VBB*-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 f6d51d5e..0529081f 100644
--- a/readme.md
+++ b/readme.md
@@ -1,9 +1,9 @@
 # hafas-client
 
-**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 for the following transport networks:
+**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) – [src at `p/db`](p/db/index.js)
-- [Berlin public transport](https://en.wikipedia.org/wiki/Verkehrsverbund_Berlin-Brandenburg) – [src at `p/vbb`](p/vbb/index.js)
+- [Berlin public transport](https://en.wikipedia.org/wiki/Verkehrsverbund_Berlin-Brandenburg) - [docs](p/vbb/readme.md) – [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)