Merge pull request #4 from explore-node-js/master

sync with main repo

Author: eugene-matvejev

README.md

@@ -1,2 +1,42 @@
 # node.js-parameter-handler
 parameter handler
+
+## how to install
+```
+npm install node.js-parameter-handler
+```
+
+
+## how to execute tests
+```
+npm test
+```
+with coverage
+```
+npm test -- --coverage
+```
+
+## how to use
+include configs into root package.json into 'extra' node
+
+obverve below sample of package.json
+
+```
+# package.json
+{
+    ...
+    "extra": {
+        "node_parameter_handler": [
+            {
+                "source": "tests/fixtures/settings.json.dist", # source 
+                "output": "var/settings.json",                 # output
+                "envMap": {
+                    "touched": "BASE_URL", # json path to ENV VARIABLE
+                    "test.touched": "PWD",
+                    "test.test.touched": "HOME"
+                }
+            }
+        ]
+    }
+}
+```

package.json

@@ -1,6 +1,6 @@
 {
-    "name": "node.js-parameter-handler",
-    "version": "0.1.0",
+    "name": "node-parameter-handler",
+    "version": "0.1.1",
     "description": "build .json files which can be used as settings",
     "main": "index.js",
     "repository": {