[Pkg-javascript-commits] [node-coveralls] 204/332: added documentation for nyc and node-tap

[Bastien Roucariès]

This is an automated email from the git hooks/post-receive script.

rouca pushed a commit to branch master
in repository node-coveralls.

commit a7bd62356316196268ff03440898a8b596b6e877
Author: Benjamin Coe <ben at npmjs.com>
Date:   Sat May 23 14:23:21 2015 -0700

    added documentation for nyc and node-tap
---
 README.md | 31 +++++++++++++++++++++----------
 1 file changed, 21 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index e80df74..aacde2b 100644
--- a/README.md
+++ b/README.md
@@ -6,15 +6,15 @@
 
 Supported CI services:  [travis-ci](https://travis-ci.org/), [codeship](https://www.codeship.io/), [circle-ci](https://circleci.com/), [jenkins](http://jenkins-ci.org/)
 
-##Installation: 
+##Installation:
 Add the latest version of `coveralls` to your package.json:
-``` 
-npm install coveralls --save 
+```
+npm install coveralls --save
 ```
 
 If you're using mocha, add `mocha-lcov-reporter` to your package.json:
-``` 
-npm install mocha-lcov-reporter --save 
+```
+npm install mocha-lcov-reporter --save
 ```
 
 ##Usage:
@@ -29,7 +29,7 @@ This library currently supports [travis-ci](https://travis-ci.org/) with no extr
 
 There are optional environment variables for other build systems as well:
 * COVERALLS_SERVICE_JOB_ID  (an id that uniquely identifies the build job)
-* COVERALLS_RUN_AT  (a date string for the time that the job ran.  RFC 3339 dates work.  This defaults to your 
+* COVERALLS_RUN_AT  (a date string for the time that the job ran.  RFC 3339 dates work.  This defaults to your
 build system's date/time if you don't set it.)
 
 ### [Mocha](http://mochajs.org/) + [Blanket.js](https://github.com/alex-seville/blanket)
@@ -44,7 +44,7 @@ NODE_ENV=test YOURPACKAGE_COVERAGE=1 ./node_modules/.bin/mocha \
 ```
 ### [Mocha](http://mochajs.org/) + [JSCoverage](https://github.com/fishbar/jscoverage)
 
-Instrumenting your app for coverage is probably harder than it needs to be (read [here](http://www.seejohncode.com/2012/03/13/setting-up-mocha-jscoverage/)), but that's also a necessary step. 
+Instrumenting your app for coverage is probably harder than it needs to be (read [here](http://www.seejohncode.com/2012/03/13/setting-up-mocha-jscoverage/)), but that's also a necessary step.
 
 In mocha, if you've got your code instrumented for coverage, the command for a travis build would look something like this:
 ```sh
@@ -108,6 +108,20 @@ Client-side JS code coverage using [PhantomJS](https://github.com/ariya/phantomj
 lab -r lcov | ./node_modules/.bin/coveralls
 ```
 
+### [nyc](https://github.com/bcoe/nyc)
+
+works with almost any testing framework, simply execute
+`npm test` with the `nyc` bin, followed by running its reporter:
+
+```
+nyc npm test && nyc report --reporter=text-lcov | coveralls
+```
+
+### [tap](https://github.com/isaacs/node-tap)
+
+Simply run your tap tests with the `COVERALLS_REPO_TOKEN` environment
+variable set, and tap will automatically use `nyc` to report
+coverage to coveralls.
 
 ## Running locally
 
@@ -129,6 +143,3 @@ If you want to send commit data to coveralls, you can set the `COVERALLS_GIT_COM
 I generally don't accept pull requests that are untested, or break the build, because I'd like to keep the quality high (this is a coverage tool afterall!).
 
 I also don't care for "soft-versioning" or "optimistic versioning" (dependencies that have ^, x, > in them, or anything other than numbers and dots).  There have been too many problems with bad semantic versioning in dependencies, and I'd rather have a solid library than a bleeding edge one.
-
-
-

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-coveralls.git