Permalink
Browse files

Update help text in README to match new options; up version

  • Loading branch information...
1 parent 6dfdac6 commit 2b69518e37dffeb7b34b988a46e301bc7f1b33c2 @gotwarlost committed Sep 18, 2012
Showing with 9 additions and 7 deletions.
  1. +8 −6 README.md
  2. +1 −1 package.json
View
14 README.md
@@ -59,7 +59,6 @@ Command line options
--tmp <dir> : tmp directory under which instrumented files will be written
(default: /tmp)
--colors : show colored output (use --no-colors to disable)
- (default: true)
Tests and results
--include <pattern> : include file patterns for test files
@@ -69,21 +68,24 @@ Command line options
--save-results : save results to disk
--results-format <format> : results file format
--results-file <name> : basename of results file without extension
- (default: ./results)
+ (default: results)
Instrumentation and coverage
--coverage, -c : enable instrumentation and coverage stats
+ --istanbul : use istanbul instead of YUI coverage for instrumentation and coverage stats
--fast-cover : skip source coverage if a newer instrumented file found from previous run
--cov-include <pattern> : include file patterns for JS files to be instrumented
- (default: [*.js, lib/**/*.js])
+ (default: [**/*.js])
--cov-exclude <pattern> : exclude file patterns for instrumentation
- (default: [**/.*, **/node_modules/**])
+ (default: [test/**/*.js, tests/**/*.js, **/.*, **/node_modules/**])
--save-coverage : save JSON coverage information to disk
--coverage-file <name> : basename of JSON coverage file without extension
- (default: ./coverage/test-coverage)
+ (default: coverage/test-coverage)
--coverage-report-format <format> : format of coverage report (default: lcov)
-In addition, the environment variable `ytestopts` can be set with override options. These take precedence over the options passed to command line.
+
+ In addition, the environment variable [ytestopts] can be set with override options.
+ These take precedence over the options passed to command line.
Using this module effectively
-----------------------------
View
2 package.json
@@ -2,7 +2,7 @@
"name":"ytestrunner",
"author":"Krishnan Anantheswaran <kananthmail-github@yahoo.com>",
"description":"Run YUI tests for node packages using npm test with support for saving test results, coverage and more. Supports YUITest as well as YUI3 style tests.",
- "version":"0.2.0",
+ "version":"0.2.1",
"repository":{
"type":"git",
"url":"git://github.com/gotwarlost/ytestrunner.git"

0 comments on commit 2b69518

Please sign in to comment.