Browse files

Added a simple Readme

  • Loading branch information...
1 parent d7d5b60 commit 7d6e647bb0b15ef7a34fbbfa2360fdf0a4f140e3 @davglass davglass committed Aug 17, 2012
Showing with 24 additions and 1 deletion.
  1. +23 −0 nodejs-coverage/README.md
  2. +1 −1 nodejs-coverage/package.json
View
23 nodejs-coverage/README.md
@@ -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
+
+```
View
2 nodejs-coverage/package.json
@@ -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": [

0 comments on commit 7d6e647

Please sign in to comment.