add README.md

Author: Max-Z80

Readme.md

@@ -0,0 +1,43 @@
+`waterConsumption` is a web based application to monitor your water consumption.
+
+# Features
+
+- visualize your water consumption over time
+- add a new reading as indicated from your water meter
+- edit a reading
+
+# Screenshots
+
+<img src='./doc/screenshot.png' width="400px" style="margin:auto; display:block"/>
+
+# From a technical POV
+
+This project has a server/client architecture.
+
+The backend is simple: a REST API, data stored in a plain csv file.
+
+The frontend is currently simple just html, javascript. No use of a framework yet, but as the project grows and more features are needed, I think it will be easier to flip to react.js
+
+# Requirements
+
+- nodejs
+
+# Installation
+
+Install the dependencies of the project:
+
+```
+npm install
+```
+
+You can start the server with:
+
+```
+node ./server.js
+```
+
+With your browser, type the following in the address bar:
+
+```
+http://localhost:1234/public/index.html
+```

consumption.csv

@@ -1,27 +1,8 @@
 date;m3
 2020-12-18;100
-2020-12-20;123
-2020-12-25;222
-2020-12-26;300
-2020-12-10;50
-2020-12-24;250
-2020-12-23;300
-2020-12-22;400
-2020-12-11;500
-2020-12-31;600
-2020-12-01;20
-2020-12-02;123
-2020-12-03;300
-2020-12-04;300
-2020-12-05;400
-2020-12-05;500
-2020-12-06;456
-2020-12-07;666
-2020-11-02;444
-2020-11-03;132
-2020-11-04;500
-2020-11-05;100
-2020-11-06;900
-2020-11-11;300
-2020-11-20;500
-2020-11-23;1000
+2020-12-20;110
+2020-12-25;150
+2020-12-26;160
+2020-12-27;165
+2020-12-28;170
+2020-12-31;200

doc/screenshot.png

@@ -1,5 +1,9 @@
 {
-  "name": "consumptionchecker",
+  "name": "waterConsumption",
+  "author": {
+    "name": "Max-Z80",
+    "email": "chaillet.dev@gmail.com"
+  },
   "version": "0.1.0",
   "private": true,
   "dependencies": {