aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcainus <[email protected]>2013-06-22 15:44:42 -0700
committercainus <[email protected]>2013-06-22 15:44:42 -0700
commit7f43f5d8cc39cb47687ecdba7034baf9eac46ba4 (patch)
treef1a81b926039b01ba7d42e6757eec3fba5e9dedf
parentba65a7dd5e05e9ad97d36f2f893e8a8642aed517 (diff)
parent187dc098763f9b8e9f6ebc839b93210bfde8bac2 (diff)
downloadnode-coveralls-7f43f5d8cc39cb47687ecdba7034baf9eac46ba4.tar.xz
node-coveralls-7f43f5d8cc39cb47687ecdba7034baf9eac46ba4.zip
merge
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index 40d3ece..3ccd94a 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,17 @@ 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)
+* 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.)
###[Blanket.js](https://github.com/alex-seville/blanket)
- Install [blanket.js](http://blanketjs.org/)