confess - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "confess",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "A configuration wrapper around the configuration manager `convict`",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -62,2 +62,18 @@ # confess
 
+The object that gets returned is the `convict` config object. So to get a config
+value, just use it like you would in `convict`.
+
+```js
+'use strict';
+
+var config = require('confess');
+
+config.get('port');
+config.get('session.secret');
+
+```
+
+For more documentation on things you can do with the `convict` config object,
+see [their documentation](https://github.com/mozilla/node-convict);
+
 # Configuration
@@ -84,2 +100,2 @@
 To view example folder/file structures, view the
-[`https://github.com/ksmithut/confess/tree/master/examples`](examples directory).
+[examples directory](https://github.com/ksmithut/confess/tree/master/examples).

No alert changes

Improved metrics

Total package byte prevSize

9145

increased by4.41%

Number of lines in readme file

100

increased by19.05%

No dependency changes