Support electron-mocha

.gitignore

@@ -3,4 +3,5 @@
 /node_modules
 /lib
 /npm-debug.log
-/coverage
+/coverage
+/.nyc_output

README.md

@@ -49,6 +49,7 @@ Tutorials:
 * [Mocha and Istanbul Guide](./docs/HOWTO-istanbul.md)
 * [Mocha and JSCoverage Guide](./docs/HOWTO-jscoverage.md)
 * [Istanbul and Tape Guide](./docs/HOWTO-tape-not-mocha.md) courtesy [@jessaustin](https://github.com/jessaustin).
+* [Electron-mocha and nyc Guide](./docs/HOWTO-electron-mocha.md)
 * [Codeship and Coveralls](./docs/HOWTO-codeship-and-coveralls.md)
 * [Travis-CI and Coveralls](./docs/HOWTO-travisci-and-coveralls.md)
 * [Ignoring code with Pragmas](./docs/pragmas.md)

docs/HOWTO-electron-mocha.md

@@ -0,0 +1,49 @@
+Running with [Electron-mocha](https://github.com/jprichardson/electron-mocha)
+---------------------------------------------------------------
+
+Contents
+========
+
+* [Quick Start with Electron-mocha](#quick-start-with-electron-mocha)
+  * [Run with NPM](#run-with-npm)
+
+Quick Start with Electron-mocha and Nyc
+---------------------------------------
+
+Electron-mocha is an awesome project allowing you to test your sources within electron processes, either main or renderer.
+
+[Nyc](https://github.com/istanbuljs/nyc) is the latest Istanbul command line interface, which simplifies a lot instrumentation and reporting.
+
+Assuming you have a coffee-script/electron project with tests cases stored in /test, `cd` to your project and run:
+
+    npm install --save-dev coffee-coverage nyc electron-mocha
+
+Now you're ready to run your tests
+
+    ./node_modules/.bin/nyc --reporter lcov --reporter text ./node_modules/.bin/electron-mocha --renderer --compilers coffee:coffee-script/register -r coffee-coverage/register-istanbul -R spec test/**/*.coffee
+
+Run with NPM
+============
+
+Save your mocha options in `/test/mocha.opts`:
+
+```sh
+--require coffeescript/register
+--require coffee-coverage/register-istanbul
+--reporter spec
+```
+
+In package.json, add:
+
+```json
+"scripts": {
+    "test": "nyc electron-mocha --renderer test/**/*.coffee"
+}
+...
+"nyc": {
+    "reporter": ["lcov","text"]
+},
+...
+``
+
+now you can run `npm test` to run your tests and generate a coverage report, both in console and in `coverage/lcov-report/index.html`