[Pkg-javascript-commits] [node-coveralls] 07/332: Update README.md

[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 e584c4004cf64ca378a63131e0e751803865f49c
Author: Gregg Caines <gregg at caines.ca>
Date:   Sat Mar 23 19:34:55 2013 -0700

    Update README.md
---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index e69de29..e7f217d 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,14 @@
+#node-coveralls
+
+[Coveralls.io](https://coveralls.io/) support for node.js.  Get the great coverage reporting of coveralls.io and add a cool coverage button ( like this: ![](https://s3.amazonaws.com/assets.coveralls.io/badges/coveralls_94.png) ) to your README.
+
+Installation: Add the latest version of `coveralls` to your package.json.
+
+This script ( `bin/coveralls.js` ) can take standard input in the JSON format from [mocha](http://visionmedia.github.com/mocha/)'s JSONCov reporter and send it to coveralls.io to report your code coverage there.  It needs to run from [travis-ci](http://about.travis-ci.org/docs/user/languages/javascript-with-nodejs/) to work.
+
+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/) or [here](http://tjholowaychuk.com/post/18175682663/mocha-test-coverage), but that's also a necessary step. 
+
+Once your app is instrumented for coverage, and building in travis-ci, you just need to set your mocha reporter to the JSONCov reporter, and pipe the output to `./node_modules/coveralls/bin/coveralls.js`.  
+
+Check out an example [Makefile](https://github.com/cainus/Prozess/blob/master/Makefile) from one of my projects for an example, especially the test-coveralls build target.  Note: Travis runs `npm test`, so whatever target you create in your Makefile must be the target that `npm test` runs.  Also note that the TRAVIS_JOB_ID is necessary.
+

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