aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGregg Caines <[email protected]>2013-06-02 21:43:37 -0600
committerGregg Caines <[email protected]>2013-06-02 21:43:37 -0600
commit49936b7647ac7cc1855cafe87ed823638d690d10 (patch)
tree3fb0980041f1d54d1a246dc63bd64a8477cfa6ae
parent01dba7323c708863fff540ef8c4d07e58b149322 (diff)
downloadnode-coveralls-49936b7647ac7cc1855cafe87ed823638d690d10.tar.xz
node-coveralls-49936b7647ac7cc1855cafe87ed823638d690d10.zip
added this project's own coverage shield to the README
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index e484a36..ec7f8a7 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,13 @@
#node-coveralls
[![Build Status](https://travis-ci.org/cainus/node-coveralls.png?branch=master)](https://travis-ci.org/cainus/node-coveralls)
+[![Coverage Status](https://coveralls.io/repos/cainus/node-coveralls/badge.png?branch=master)](https://coveralls.io/r/cainus/node-coveralls?branch=master)
[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.
+Installation: Add the latest version of `coveralls` to your package.json:
+```
+npm install coveralls --save
+```
This script ( `bin/coveralls.js` ) can take standard input from any tool that emits the lcov data format (including [mocha](http://visionmedia.github.com/mocha/)'s [LCov reporter](https://npmjs.org/package/mocha-lcov-reporter)) and send it to coveralls.io to report your code coverage there.