Skip to content

Commit

Permalink
Added a simple Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
davglass committed Aug 17, 2012
1 parent d7d5b60 commit 7d6e647
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
23 changes: 23 additions & 0 deletions nodejs-coverage/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
YUI Test Coverage Node.js Module
================================


This module is a wrapper around the YUITest Coverage Java module that you
can call from a Node.js process.

Example
-------


```javascript

var coverage = require('yuitest-coverage');

coverage.cover('/path/to/file', function(err, data) {
//err will be populated with the stderr from the java process
//data will be a string of the covered contents, you write the file out
});

coverage.cover('<string from a file>', callback); // also works

```
2 changes: 1 addition & 1 deletion nodejs-coverage/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "yuitest-coverage",
"description": "Node.js wrapper for yuitest-coverage java package",
"version": "0.0.1",
"version": "0.0.2",
"author": "Dav Glass <davglass@gmail.com>",
"bugs": { "url" : "http://yuilibrary.com/projects/yuitest/newticket" },
"keywords": [
Expand Down

0 comments on commit 7d6e647

Please sign in to comment.