aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGregg Caines <[email protected]>2013-06-22 16:04:00 -0600
committerGregg Caines <[email protected]>2013-06-22 16:04:00 -0600
commit8d5ae54ba507f6690b2f4f26a4bb7ff7c53cc090 (patch)
tree8d38a411e243450c487f5e94792822a31f33252c
parent311cdeedb62363ec047f0cfe8f1d9460a9735c3a (diff)
downloadnode-coveralls-8d5ae54ba507f6690b2f4f26a4bb7ff7c53cc090.tar.xz
node-coveralls-8d5ae54ba507f6690b2f4f26a4bb7ff7c53cc090.zip
Update README.md
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index 40d3ece..f62e621 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,15 @@ npm install mocha-lcov-reporter --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.
-Once your app is instrumented for coverage, and building, you just need to pipe the lcov output to `./node_modules/coveralls/bin/coveralls.js`.
+Once your app is instrumented for coverage, and building, you need to pipe the lcov output to `./node_modules/coveralls/bin/coveralls.js`.
+
+This library currently supports [travis-ci](https://travis-ci.org/) with no extra effort beyond that, but if
+you're using a different build system, there are a few environment variables that are necessary:
+* COVERALLS_SERVICE_NAME (the name of your build system)
+* COVERALLS_REPO_TOKEN (the secret repo token from coveralls.io)
+
+There are optional environment variables for other build systems as well:
+* COVERALLS_SERVICE_JOB_ID (an id that uniquely identifies the build job)
###[Blanket.js](https://github.com/alex-seville/blanket)
- Install [blanket.js](http://blanketjs.org/)