docs: add documentation referencing puppeteer-to-istanbul (#2135)

Fixes #1768.
puppeteer · Mar 7, 2018 · edc510c · edc510c
1 parent c857aef
commit edc510c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -2557,6 +2557,9 @@ for (const entry of coverage) {
 console.log(`Bytes used: ${usedBytes / totalBytes * 100}%`);
 ```
 
+_To output coverage in a form consumable by [Istanbul](https://github.com/istanbuljs),
+  see [puppeteer-to-istanbul](https://github.com/istanbuljs/puppeteer-to-istanbul)._
+
 #### coverage.startCSSCoverage(options)
 - `options` <[Object]>  Set of configurable options for coverage
   - `resetOnNavigation` <[boolean]> Whether to reset coverage on every navigation. Defaults to `true`.

diff --git a/examples/README.md b/examples/README.md
@@ -40,3 +40,4 @@ const browser = await puppeteer.launch({
 
 - [angular-puppeteer-demo](https://github.com/Quramy/angular-puppeteer-demo) - Demo repository explaining how to use Puppeteer in Karma.
 - [mocha-headless-chrome](https://github.com/direct-adv-interfaces/mocha-headless-chrome) - Tool which runs client-side **mocha** tests in the command line through headless Chrome.
+- [puppeteer-to-istanbul-example](https://github.com/bcoe/puppeteer-to-istanbul-example) - Demo repository demonstrating how to output Puppeteer coverage in Istanbul format.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -40,3 +40,4 @@ const browser = await puppeteer.launch({

		- [angular-puppeteer-demo](https://github.com/Quramy/angular-puppeteer-demo) - Demo repository explaining how to use Puppeteer in Karma.
		- [mocha-headless-chrome](https://github.com/direct-adv-interfaces/mocha-headless-chrome) - Tool which runs client-side mocha tests in the command line through headless Chrome.
		- [puppeteer-to-istanbul-example](https://github.com/bcoe/puppeteer-to-istanbul-example) - Demo repository demonstrating how to output Puppeteer coverage in Istanbul format.