Add basic documentation

README.md

@@ -1 +1,40 @@
-# lanuv-parser
+# lanuv-parser
+
+Simple parser for [Luftqualitätsüberwachungssystem LUQS](https://www.lanuv.nrw.de/umwelt/luft/luftueberwachung/luftqualitaetsueber-wachungssystem-luqs) by [Landesamt für Natur, Umwelt und Verbraucherschutz Nordrhein-Westfalen LANUV](https://www.lanuv.nrw.de/).
+
+## Install
+
+```
+$ npm install lanuv-parser or yarn add lanuv-parser
+```
+
+## Usage
+```js
+const luqs = require('lanuv-parser')
+
+const run = async () => {
+  const stations = await luqs()
+  console.log(stations)
+}
+
+run()
+
+```
+
+## API
+
+### luqs()
+Returns an array containing all LUQS stations.
+
+Source: https://www.lanuv.nrw.de/luqs/messorte/messorte.php
+
+### luqs.station(kuerzel)
+Returns detailed information about a specific LUQS station
+
+Source: https://www.lanuv.nrw.de/luqs/messorte/steckbrief.php?ort={KUERZEL}
+
+### luqs.aktuell()
+
+Returns the current measurements for all LUQS stations.
+
+Source: https://www.lanuv.nrw.de/fileadmin/lanuv/luft/immissionen/aktluftqual/eu_luft_akt.htm

package.json

@@ -1,6 +1,6 @@
 {
   "name": "lanuv-parser",
-  "version": "1.0.0",
+  "version": "0.1.0",
   "description": "Parse LANUV website for LUQS (Air Quality) stations",
   "license": "MIT",
   "repository": "mpfeil/lanuv-parser",