aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNick Merwin <[email protected]>2015-12-10 12:52:55 -0800
committerNick Merwin <[email protected]>2015-12-10 12:52:55 -0800
commitd084add18e87fd1a292315de7c9eb171e8fd4b93 (patch)
treec90578e6a9540b8af75a930dc25d3c07be4efee6 /README.md
parent712e6e4bb4d8e1a60f646d954743a6808aa7f13e (diff)
parentd60635885d243abef2cbc5b2a0da7a27d752a14b (diff)
downloadnode-coveralls-d084add18e87fd1a292315de7c9eb171e8fd4b93.tar.xz
node-coveralls-d084add18e87fd1a292315de7c9eb171e8fd4b93.zip
merge conflictspr/96
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 16 insertions, 7 deletions
diff --git a/README.md b/README.md
index eb28744..842c532 100644
--- a/README.md
+++ b/README.md
@@ -4,17 +4,17 @@
[Coveralls.io](https://coveralls.io/) support for node.js. Get the great coverage reporting of coveralls.io and add a cool coverage button ( like the one above ) to your README.
-Supported CI services: [travis-ci](https://travis-ci.org/), [codeship](https://www.codeship.io/), [circle-ci](https://circleci.com/), [jenkins](http://jenkins-ci.org/)
+Supported CI services: [travis-ci](https://travis-ci.org/), [codeship](https://www.codeship.io/), [circleci](https://circleci.com/), [jenkins](http://jenkins-ci.org/)
##Installation:
Add the latest version of `coveralls` to your package.json:
```
-npm install coveralls --save
+npm install coveralls --save-dev
```
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-dev
```
##Usage:
@@ -123,20 +123,29 @@ Simply run your tap tests with the `COVERALLS_REPO_TOKEN` environment
variable set and tap will automatically use `nyc` to report
coverage to coveralls.
+### Command Line Parameters
+Usage: coveralls.js [-v] filepath
+
+#### Optional arguments:
+
+-v, --verbose
+
+filepath - optionally defines the base filepath of your source files.
+
## Running locally
If you're running locally, you must have a `.coveralls.yml` file, as documented in [their documentation](https://coveralls.io/docs/ruby), with your `repo_token` in it; or, you must provide a `COVERALLS_REPO_TOKEN` environment-variable on the command-line.
If you want to send commit data to coveralls, you can set the `COVERALLS_GIT_COMMIT` environment-variable to the commit hash you wish to reference. If you don't want to use a hash, you can set it to `HEAD` to supply coveralls with the latest commit data. This requires git to be installed and executable on the current PATH.
-[travis-image]: https://travis-ci.org/cainus/node-coveralls.svg?branch=master
-[travis-url]: https://travis-ci.org/cainus/node-coveralls
+[travis-image]: https://travis-ci.org/nickmerwin/node-coveralls.svg?branch=master
+[travis-url]: https://travis-ci.org/nickmerwin/node-coveralls
[codeship-image]: https://www.codeship.io/projects/de6fb440-dea9-0130-e7d9-122ca7ee39d3/status
[codeship-url]: https://www.codeship.io/projects/5622
-[coveralls-image]: https://img.shields.io/coveralls/cainus/node-coveralls/master.svg
-[coveralls-url]: https://coveralls.io/r/cainus/node-coveralls?branch=master
+[coveralls-image]: https://coveralls.io/repos/nickmerwin/node-coveralls/badge.svg?branch=master&service=github
+[coveralls-url]: https://coveralls.io/github/nickmerwin/node-coveralls?branch=master
## Contributing