From 00b184df360c7ea171b8ea721d282a270c7eee64 Mon Sep 17 00:00:00 2001
From: Kevin Arutyunyan <d3d9@riseup.net>
Date: Thu, 22 Aug 2019 17:52:53 +0200
Subject: [PATCH] Add readme for DB Busradar NRW profile and add entry in
 profile overview

---
 p/db-busradar-nrw/readme.md | 19 +++++++++++++++++++
 readme.md                   |  1 +
 2 files changed, 20 insertions(+)
 create mode 100644 p/db-busradar-nrw/readme.md

diff --git a/p/db-busradar-nrw/readme.md b/p/db-busradar-nrw/readme.md
new file mode 100644
index 00000000..4bd0cde5
--- /dev/null
+++ b/p/db-busradar-nrw/readme.md
@@ -0,0 +1,19 @@
+# DB Busradar NRW profile for `hafas-client`
+
+[*DB Busradar NRW*](https://www.bahn.de/westfalenbus/view/fahrplan/busradar.shtml) is a mobile application used in [North Rhine-Westphalia](https://en.wikipedia.org/wiki/North_Rhine-Westphalia).
+It shows realtime locations and arrival/departure information for vehicles operated by bus companies which are part of [DB Regio Bus](https://www.dbregio.de/db_regio/view/wir/bus.shtml) in NRW, namely:
+- [BVR Busverkehr Rheinland GmbH](https://www.rheinlandbus.de/) (DB Rheinlandbus)
+- [WB Westfalen Bus GmbH](https://www.westfalenbus.de/) (DB Westfalenbus)
+- [BVO Busverkehr Ostwestfalen GmbH](https://www.ostwestfalen-lippe-bus.de) (DB Ostwestfalen-Lippe-Bus)
+
+This profile adapts `hafas-client` to the HAFAS endpoint used by the application.
+
+## Usage
+
+```js
+const createClient = require('hafas-client')
+const dbbusradarnrwProfile = require('hafas-client/p/db-busradar-nrw')
+
+// create a client with DB Busradar NRW profile
+const client = createClient(dbbusradarnrwProfile, 'my-awesome-program')
+```
diff --git a/readme.md b/readme.md
index 19f1275f..bad9e577 100644
--- a/readme.md
+++ b/readme.md
@@ -16,6 +16,7 @@ HAFAS endpoint | wrapper library | docs | example code | source code
 [Société Nationale des Chemins de Fer Luxembourgeois (CFL)](https://en.wikipedia.org/wiki/Société_Nationale_des_Chemins_de_Fer_Luxembourgeois) | - | [docs](p/cfl/readme.md) | [example code](p/cfl/example.js) | [src](p/cfl/index.js)
 [Hamburg public transport (HVV)](https://en.wikipedia.org/wiki/Hamburger_Verkehrsverbund) | - | [docs](p/hvv/readme.md) | [example code](p/hvv/example.js) | [src](p/hvv/index.js)
 [*Nordhessischer Verkehrsverbund (NVV)*](https://en.wikipedia.org/wiki/Nordhessischer_Verkehrsverbund) ([Hesse](https://en.wikipedia.org/wiki/Hesse)) | - | [docs](p/nvv/readme.md) | [example code](p/nvv/example.js) | [src](p/nvv/index.js)
+*DB Busradar NRW* ([DB Regio Bus](https://en.wikipedia.org/wiki/DB_Regio#Bus_division_(DB_Regio_Bus))) | - | [docs](p/db-busradar-nrw/readme.md) | [example code](p/db-busradar-nrw/example.js) | [src](p/db-busradar-nrw/index.js)
 
 There are also client libraries that use the library, but contain their own customisations: