Skip to content

Commit

Permalink
Merge pull request #2 from jacob-meacham/bugfix/docs
Browse files Browse the repository at this point in the history
#1: Fix a few issues with the docs.
  • Loading branch information
jacob-meacham committed Jun 3, 2015
2 parents 80c2aa9 + 683177b commit bbe602c
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Default: `['file']`
What emitters to send the merged data to. Supported emitters are 'file', which sends the merged data to a file, and 'event', which sends it out to the 'coverage' event and can be listened to with

```js
grunt.event.on('coverage', fucntion(lcov, done) {});
grunt.event.on('coverage', function(lcov, done) {});
```

#### outputFile
Expand All @@ -48,7 +48,7 @@ If a file emitter is specified, this is the output file to pipe data to.
```js
grunt.initConfig({
jshint: {
files: ['Gruntfile.js', 'tasks/**/*.js', 'test/**/*.js'],
src: ['Gruntfile.js', 'tasks/**/*.js', 'test/**/*.js'],
options: {
jshintrc: true
}
Expand All @@ -69,7 +69,7 @@ If a file emitter is specified, this is the output file to pipe data to.
emitters: ['event', 'file'],
outputFile: 'mergeLcov.info'
},
files: ['build/coverage/*.info', 'build/coverage/**/*.info']
src: ['build/coverage/*.info', 'build/coverage/**/*.info']
}
});

Expand All @@ -81,6 +81,8 @@ If a file emitter is specified, this is the output file to pipe data to.
grunt.loadNpmTasks('grunt-lcov-merge');
```

Note that grunt-lcov-merge allows for source files to be specified via any [file format](http://gruntjs.com/configuring-tasks#files).

## Event emitter
One of the most useful ways to consume this plugin is to use the coverage event to send the lcov data to a service like coveralls:

Expand Down

0 comments on commit bbe602c

Please sign in to comment.