Skip to content

Commit

Permalink
Fix a few issues with the docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
jacob-meacham committed Jun 3, 2015
1 parent 80c2aa9 commit 683177b
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

1 comment on commit 683177b

@thomasstreckercc
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just using src works for me as well. Thank you!

Please sign in to comment.