aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKir Belevich <[email protected]>2013-12-02 14:27:33 +0200
committerKir Belevich <[email protected]>2013-12-02 14:27:33 +0200
commit07188edd11da30d04e0f8680c3ef725348e28554 (patch)
treef63e02505e8fcfa801a8cc94fba04a0939200da4
parentbe9cf789b3db0158b8364a48475e5671d45f16e8 (diff)
downloadnode-coveralls-07188edd11da30d04e0f8680c3ef725348e28554.tar.xz
node-coveralls-07188edd11da30d04e0f8680c3ef725348e28554.zip
update README with Poncho usage information
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index bc45b06..fa8b91f 100644
--- a/README.md
+++ b/README.md
@@ -86,6 +86,16 @@ npm run coveralls
For detailed instructions on requiring instrumented code, running on Travis and submitting to coveralls [see this guide](https://github.com/alanshaw/nodeunit-lcov-coveralls-example).
+### [Poncho](https://github.com/deepsweet/poncho)
+Client-side JS code coverage using [PhantomJS](https://github.com/ariya/phantomjs), [Mocha](https://github.com/visionmedia/mocha) and [Blanket](https://github.com/alex-seville/blanket):
+- [Configure](http://visionmedia.github.io/mocha/#browser-support) Mocha for browser
+- [Mark](https://github.com/deepsweet/poncho#usage) target script(s) with `data-cover` html-attribute
+- Run your tests with a command like this:
+
+```sh
+./node_modules/.bin/poncho -R lcov test/test.html | ./node_modules/coveralls/bin/coveralls.js
+```
+
## 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.