Skip to content

Commit cea345a

Browse files
yamikuronuethebigredgeek
authored andcommitted
docs: Simplified language in the opening paragraph. Closes #340 (#373)
* docs: Simplified language in the opening paragraph. Closes #340 * fix: Adjust wording as per @thebigredgeek
1 parent f1ca2ab commit cea345a

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# debug
22
[![Build Status](https://travis-ci.org/visionmedia/debug.svg?branch=master)](https://travis-ci.org/visionmedia/debug)
33

4-
tiny node.js debugging utility modelled after node core's debugging technique.
4+
A tiny node.js debugging utility modelled after node core's debugging technique.
55

66

77
## Installation
@@ -12,7 +12,7 @@ $ npm install debug
1212

1313
## Usage
1414

15-
With `debug` you simply invoke the exported function to generate your debug function, passing it a name which will determine if a noop function is returned, or a decorated `console.error`, so all of the `console` [format string goodies](https://developer.chrome.com/devtools/docs/console-api#consolelogobject-object) you're used to work fine. A unique color is selected per-function for visibility.
15+
`debug` exposes a function; simply pass this function the name of your module, and it will return a decorated version of `console.error` for you to pass debug statements to. This will allow you to toggle the debug output for different parts of your module as well as the module as a whole.
1616

1717
Example _app.js_:
1818

0 commit comments

Comments
 (0)