Skip to content

Commit

Permalink
docs: Simplified language in the opening paragraph. Closes #340 (#373)
Browse files Browse the repository at this point in the history
* docs: Simplified language in the opening paragraph. Closes #340

* fix: Adjust wording as per @thebigredgeek
  • Loading branch information
yamikuronue authored and thebigredgeek committed Dec 16, 2016
1 parent f1ca2ab commit cea345a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# debug
[![Build Status](https://travis-ci.org/visionmedia/debug.svg?branch=master)](https://travis-ci.org/visionmedia/debug)

tiny node.js debugging utility modelled after node core's debugging technique.
A tiny node.js debugging utility modelled after node core's debugging technique.


## Installation
Expand All @@ -12,7 +12,7 @@ $ npm install debug

## Usage

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.
`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.

Example _app.js_:

Expand Down

0 comments on commit cea345a

Please sign in to comment.