From e3106949a58390333db645fe5e1040bc3849c2f5 Mon Sep 17 00:00:00 2001 From: Jonathan Porta Date: Mon, 10 Nov 2014 16:41:01 -0800 Subject: Document possible command line params --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 3223f42..7d62da3 100644 --- a/README.md +++ b/README.md @@ -109,6 +109,13 @@ Client-side JS code coverage using [PhantomJS](https://github.com/ariya/phantomj lab -r lcov | ./node_modules/.bin/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 -- cgit v1.2.3 From 701abbcec5f43cd1387e3a9f9d041243f419f17c Mon Sep 17 00:00:00 2001 From: Jonathan Porta Date: Mon, 10 Nov 2014 16:41:42 -0800 Subject: Typo --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 7d62da3..a73e7bb 100644 --- a/README.md +++ b/README.md @@ -115,6 +115,7 @@ Usage: coveralls.js [-v] filepath #### Optional arguments: -v, --verbose + filepath - optionally defines the base filepath of your source files. ## Running locally -- cgit v1.2.3 From 375ad5ea62e7ee4a2eb376f27cfa080da7633784 Mon Sep 17 00:00:00 2001 From: Nick Merwin Date: Thu, 2 Jul 2015 10:21:37 -0700 Subject: updated travis badge --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index e80df74..48f9a5a 100644 --- a/README.md +++ b/README.md @@ -115,8 +115,8 @@ If you're running locally, you must have a `.coveralls.yml` file, as documented 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 -- cgit v1.2.3 From 64653c6df1d63065b0fb0b4984ac4c88f809b068 Mon Sep 17 00:00:00 2001 From: Nick Merwin Date: Mon, 13 Jul 2015 22:21:19 -0700 Subject: package updated version + maintainers README badges updates --- README.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 48f9a5a..870e11e 100644 --- a/README.md +++ b/README.md @@ -6,15 +6,15 @@ Supported CI services: [travis-ci](https://travis-ci.org/), [codeship](https://www.codeship.io/), [circle-ci](https://circleci.com/), [jenkins](http://jenkins-ci.org/) -##Installation: +##Installation: Add the latest version of `coveralls` to your package.json: -``` -npm install coveralls --save +``` +npm install coveralls --save ``` 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 ``` ##Usage: @@ -29,7 +29,7 @@ This library currently supports [travis-ci](https://travis-ci.org/) with no extr 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 +* 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.) ### [Mocha](http://mochajs.org/) + [Blanket.js](https://github.com/alex-seville/blanket) @@ -44,7 +44,7 @@ NODE_ENV=test YOURPACKAGE_COVERAGE=1 ./node_modules/.bin/mocha \ ``` ### [Mocha](http://mochajs.org/) + [JSCoverage](https://github.com/fishbar/jscoverage) -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/)), but that's also a necessary step. +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/)), but that's also a necessary step. In mocha, if you've got your code instrumented for coverage, the command for a travis build would look something like this: ```sh @@ -121,14 +121,11 @@ If you want to send commit data to coveralls, you can set the `COVERALLS_GIT_COM [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 I generally don't accept pull requests that are untested, or break the build, because I'd like to keep the quality high (this is a coverage tool afterall!). I also don't care for "soft-versioning" or "optimistic versioning" (dependencies that have ^, x, > in them, or anything other than numbers and dots). There have been too many problems with bad semantic versioning in dependencies, and I'd rather have a solid library than a bleeding edge one. - - - -- cgit v1.2.3 From acb47bd706d0d503330876210b5a802ffacee231 Mon Sep 17 00:00:00 2001 From: Andrii Shumada Date: Thu, 6 Aug 2015 01:40:36 +0300 Subject: put test deps in dev-dependencies --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0ba9343..2640ab6 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,12 @@ Supported CI services: [travis-ci](https://travis-ci.org/), [codeship](https:// ##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: -- cgit v1.2.3 From ef96cf7b8147318dc164181adc2a7a626c0a14f4 Mon Sep 17 00:00:00 2001 From: Nick Merwin Date: Fri, 7 Aug 2015 11:21:40 -0700 Subject: removed dash from "circleci" in readme * closes #104 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2640ab6..ab20cc3 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [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: -- cgit v1.2.3