Merge branch 'feature/refactor'

Author: ChrisScheffler

.gitignore

@@ -58,4 +58,4 @@ typings/
 .env
 
 package-lock.json
-assets
+stuff

README.md

@@ -1,21 +1,22 @@
 # miflora
 
-Node.js package for the Xiaomi Mi Flora Plant Sensor built on top of [noble](https://github.com/noble/noble) and [ES6 promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises).
+Node.js package for the Xiaomi Mi Flora Plant Sensor built on top of [noble](https://github.com/noble/noble).
 
-![product image](http://img.site.huahuacaocao.net/production/production_05_01.png)
-
-![npm](https://img.shields.io/npm/v/miflora.svg)
+[![npm](https://img.shields.io/npm/v/miflora.svg)](https://www.npmjs.com/package/miflora)
 ![language](https://img.shields.io/github/languages/top/ChrisScheffler/miflora.svg)
+[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo)
 ![commit](https://img.shields.io/github/last-commit/ChrisScheffler/miflora.svg)
 ![firmware](https://img.shields.io/badge/firmware-3.1.8-brightgreen.svg)
-![licence](https://img.shields.io/npm/l/miflora.svg)
-
-Have a look in the [Wiki](https://github.com/ChrisScheffler/miflora/wiki).
+[![licence](https://img.shields.io/npm/l/miflora.svg)](LICENSE)
 
-**Code and readme are work in progress!**
+Have a look in the [Wiki](https://github.com/ChrisScheffler/miflora/wiki) for more information on the sensor.
 
 ---
 
+## Prerequisites
+
+Please see [the Prerequisites section for noble](https://github.com/noble/noble#prerequisites).
+
 ## Install
 
 ```sh
@@ -24,64 +25,92 @@ npm install miflora
 
 ## Usage
 
+The library uses [async/await](https://javascript.info/async-await) code syntax instead of [Promises chaining](https://javascript.info/promise-chaining) in order to execute asynchronous code sequentially. Since all internal code is based on [Promises](https://javascript.info/promise-basics) you still can use the  `method().then().catch()`-pattern regardless.
+
+*All examples use async/await syntax.*
+
+### Discover devices
+
+```javascript
+const devices = await miflora.discover();
+console.log('devices discovered: ', devices.length);
+```
+
+In this example we listen for 10000 (*default value*) milliseconds (10 seconds) and print out the number of detected devices.
+
+### Discover devices (advanced)
+
+```javascript
+const opts = {
+  duration: 60000,
+  addresses: ['c4:7c:8d:65:d6:1d', 'c4:7c:8d:65:d5:26', 'c4:7c:8d:65:e6:20']
+};
+const devices = await miflora.discover(opts);
+console.log('devices discovered: ', devices.length);
+```
+
+This time we listen for 60000 milliseconds (60 seconds) **or** until all devices from given `opts.addresses` have been discovered and print out the number of detected devices.
+
+### Query device information
+
+All query methods implicitly initiate a connection if none exists. You can call `device.connect()` explicitly if you like nevertheless.
+
+The library however **doesn't** perform a disconnect implicitly. You can call `device.disconnect()` when you have finished you queries or let you disconnect automatically from the device after 10 seconds.
+
+#### Firmaware & Battery
+
+```javascript
+const data = await device.queryFirmwareInfo();
+console.log(data);
+```
+
+Example output:
+
 ```javascript
-const miflora = require('miflora');
-
-miflora.discover().then(devices => {
-    devices.forEach(device => {
-        miflora.queryDevice(device).then(data => {
-            console.log(JSON.stringify(data, null, 2));
-        }).catch(err => {
-            console.error('error while querying device', device, ':', err);
-        });
-    });
-}).catch(err => {
-    console.error('well, something went wrong:', err);
-});
+{ address: 'c4:7c:8d:65:e6:20',
+  type: 'MiFloraMonitor',
+  firmwareInfo: { battery: 100, firmware: '3.1.8' } }
 ```
 
-### Example output
+#### Sensor values
 
 ```javascript
-{
-  "address": "c4:7c:8d:65:e5:20",
-  "rssi": -61,
-  "battery": 100,
-  "firmware": "3.1.8",
-  "data": {
-    "temperature": 22.1,
-    "lux": 324,
-    "moisture": 22,
-    "fertility": 290
-  }
-}
-{
-  "address": "c4:7c:8d:65:d5:26",
-  "rssi": -80,
-  "battery": 98,
-  "firmware": "3.1.8",
-  "data": {
-    "temperature": 20.5,
-    "lux": 164,
-    "moisture": 31,
-    "fertility": 300
-  }
-}
-{
-  "address": "c4:7c:8d:65:d5:1d",
-  "rssi": -77,
-  "battery": 99,
-  "firmware": "3.1.8",
-  "data": {
-    "temperature": 22,
-    "lux": 311,
-    "moisture": 26,
-    "fertility": 450
-  }
-}
+const data = await device.querySensorValues();
+console.log(data);
+```
+
+Example output:
+
+```javascript
+{ address: 'c4:7c:8d:65:e6:20',
+  type: 'MiFloraMonitor',
+  sensorValues: { temperature: 21.1, lux: 104, moisture: 36, fertility: 1049 } }
+```
+
+#### Serial Number
+
+```javascript
+const data = await device.querySerial();
+console.log(data);
+```
+
+#### Combined query
+
+```javascript
+const opts = {
+  firmwareInfo: true,
+  sensorValues: true,
+  serial: false;
+};
+const data = await device.query(opts);
+console.log(data);
 ```
 
 ## References
 
 - https://github.com/demirhanaydin/node-mi-flora
 - https://wiki.hackerspace.pl/projects:xiaomi-flora
+
+## Licence
+
+[MIT](LICENSE)