Permalink
Browse files

Edited README.md via GitHub

  • Loading branch information...
1 parent a781c45 commit a44ee69d844f58c95f38480c57784da7fdce8abc @JerrySievert JerrySievert committed with indexzero Aug 21, 2011
Showing with 19 additions and 0 deletions.
  1. +19 −0 README.md
View
19 README.md
@@ -27,6 +27,25 @@ synopsis
}
});
+coverage reporting
+------------------
+Code coverage reporting is available if _instrumented_ code is detected. Currently only _instrumentation_ via [node-jscoverage](https://github.com/visionmedia/node-jscoverage) is supported. When _instrumented_ code is detected and coverage reporting is enabled using any of the `--cover-plain`, `--cover-html`, or `--cover-json` options a code coverage map is generated.
+
+### downloading and installing [node-jscoverage](https://github.com/visionmedia/node-jscoverage)
+[node-jscoverage](https://github.com/visionmedia/node-jscoverage) is a binary package that needs to be compiled from source:
+
+ $ git clone https://github.com/visionmedia/node-jscoverage.git
+ $ cd node-jscoverage/
+ $ ./configure
+ checking for a BSD-compatible install... /usr/bin/install -c
+ checking whether build environment is sane... yes
+ [...]
+ $ make && sudo make install
+
+### instrumenting with jscoverage
+
+ $ jscoverage myfile.js myfile-instrumented.js
+
installation
------------

0 comments on commit a44ee69

Please sign in to comment.