depugger - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

package.json

 {
   "name": "depugger",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "small debugging utility",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -9,5 +9,31 @@ # node-depugger
 
+Depugger is a small lib that provides a debugging utility.
+
+## depugger([debug, [name]]), depugger(options)
+
+`depugger` returns a function that supports all of the `util.format` features and outputs debug messages based on the initial configuration.
+
+* `debug`: specifies if logged messages should be outputted, optional, default: false
+* `name`: a category key that will prepend every message, optional, default: ""
+* `options`: options hash that can be used to submit all of the above parameters at once
+
 ````javascript
 var depugger = require('depugger');
 
+var debug = depugger(true, 'fooDebugger');
+
+debug('foo');
+debug('bar "%s"', 'bax');
+debug('spam %d eggs', 10);
+
+//output to console:
+//[fooDebugger] foo
+//[fooDebugger] bar "bax"
+//[fooDebugger] spam 10 eggs
+````
+
+Alternatively all parameters can be specified via an options hash:
+````javascript
+var depugger = require('depugger');
+
 var debug = depugger({debug: true, name: 'fooDebugger'});
@@ -14,0 +40,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8078

increased by11.61%

Number of lines in readme file

50

increased by108.33%

No dependency changes