mocha-tldr-reporter/README.md

A super low noise mocha reporter (i.e. the "min" reporter without the crazy screen clearing)

# mocha-tldr-reporter

> A super low noise mocha reporter (i.e. the "min" reporter without the crazy screen clearing)

mocha-tldr-reporter is a reporter for [mocha](https://github.com/mochajs/mocha), patterned after the mocha-provided `min` reporter.


## Installation
Install via `npm`:

```
$ npm install --save-dev mocha-tldr-reporter
```


## Usage
If you're using [gulp](http://gulpjs.com/), use `require` to include mocha-tldr-reporter in your task, and then pass it in the `reporter` field to mocha:

``` javascript
var gulp = require('gulp');
var mocha = require('gulp-mocha');
var tldr = require('mocha-tldr-reporter');

gulp.task('test', function() {
  gulp.src('tests.js')
    .pipe(mocha({ reporter: tldr }));
});
```

If you're launching mocha from the command line, pass mocha-tldr-reporter using the `-R` or `--reporter` flag:

```
$ mocha -R mocha-tldr-reporter
```


## Authors

**Eric Herbrandson** ([eric@herbrandson.com](eric@herbrandson.com))



## License
Copyright (c) 2014 Eric Herbrandson

Released under the MIT license