Readme, more env var cause we love them

Author: TomyCesaille

README.md

@@ -1,17 +1,69 @@
 # whatsapp-tracking
 
+Proof of concept about tracking contacts in WhatsApp.
+Check out my [blog entry](https://jorislacance.fr/blog/) for in-depth info.
+
+## architecture
+
+The POC is composed of:
+
+* The Node.js WhatsApp scraper robot - Gather the data
+* The InfluxDB 2.0 service - Store the data
+* The Grafana 6.7 service - Visualize the data
+
 ## setup
 
 ```bash
-npm install
+# run the InfluxDB and Grafana services
+docker-compose up -d
+```
+
+### influxDB setup
+
+* Go to [https://localhost:9999](https://localhost:9999), setup an admin account
+  * Name the initial organization like you want, `initial-org` for instance
+  * Name the initial bucket anything, like `yolo`, we won't use the initial one because there will be sample data in it
+* Create a new bucket `whatsapp-tracking`
+* Generate a token `whatsapp-tracking-scraper` with write permission to `whatsapp-tracking` bucket
+* Generate a token `grafana` with 'all access'
+
+### grafana setup
+
+* Go to [https://localhost:3000](https://localhost:3000), setup an admin account
+* Add the data source using the plugin `Flux (InfluxDB) [BETA]` (for InfluxDB 2.0)
+  * URL: `http://influxdb:9999`
+  * with credentials: `true`
+  * Organization: `initial-org`
+  * Default Bucket: `whatsapp-tracking`
+  * Token: the grafana token
+* Import the dashboard (file `grafana-dashboard.json`)
+
+### scraper setup
+
+Create a file `.env` in the root directory to setup your environment.
+
+```text
+CONTACT_TARGET=YourContactName
+INFLUXDB_TOKEN=The whatsapp-tracking-scraper token
+INFLUXDB_ORG=initial-org
+INFLUXDB_BUCKET=whatsapp-tracking
 ```
 
-## usage
+## scraper usage
 
 ```bash
+# init the robot
+npm install
+# run the robot
 node index.js
 ```
 
+## limitation
+
+Not sure if the scraper runs on Linux...
+
 ## todo
 
-* Dockerize the scraper too ? Hardly with the peering procedure that require to scan QR code.
+* Update the link to portfolio blog entry
+* Add an image in this readme
+* Dockerize the scraper too ? Hardly with the peering procedure that requires us to scan the QR code.