From 2acc26a9a11c72c66caa417ad9cbce6c37866ddb Mon Sep 17 00:00:00 2001
From: Luke Page <luke.a.page@gmail.com>
Date: Fri, 21 Jun 2019 11:42:21 +0200
Subject: [PATCH 1/3] Add example usage to istanbul-lib-report

---
 packages/istanbul-lib-report/README.md | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/packages/istanbul-lib-report/README.md b/packages/istanbul-lib-report/README.md
index b8a48117..87b424b9 100644
--- a/packages/istanbul-lib-report/README.md
+++ b/packages/istanbul-lib-report/README.md
@@ -3,4 +3,23 @@
 [![Greenkeeper badge](https://badges.greenkeeper.io/istanbuljs/istanbul-lib-report.svg)](https://greenkeeper.io/)
 [![Build Status](https://travis-ci.org/istanbuljs/istanbul-lib-report.svg?branch=master)](https://travis-ci.org/istanbuljs/istanbul-lib-report)
 
-Core reporting utilities for istanbul. Docs to follow.
+Core reporting utilities for istanbul.
+
+## example usage
+
+```
+const libReport = require('istanbul-lib-report');
+
+const context = libReport.createContext({
+  dir: 'source/dir',
+  defaultSummarizer: 'summarizer name e.g. nested/flat/pkg',
+  watermarks: configWatermarks,
+  coverageMap,
+})
+
+const report = reports.create('report/name e.g. json/html/html-spa/text', {
+  skipEmpty: configSkipEmpty,
+  skipFull: configSkipFull
+})
+report.execute(context)
+```

From b6ca8e96a3d280a91345236c386f2169a2b1b303 Mon Sep 17 00:00:00 2001
From: Luke Page <luke.a.page@gmail.com>
Date: Sat, 22 Jun 2019 21:09:59 +0200
Subject: [PATCH 2/3] Fix comments

---
 packages/istanbul-lib-report/README.md | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/packages/istanbul-lib-report/README.md b/packages/istanbul-lib-report/README.md
index 87b424b9..3ae32acd 100644
--- a/packages/istanbul-lib-report/README.md
+++ b/packages/istanbul-lib-report/README.md
@@ -5,21 +5,26 @@
 
 Core reporting utilities for istanbul.
 
-## example usage
+## Example usage
 
-```
+```js
 const libReport = require('istanbul-lib-report');
+const reports = require('istanbul-reports');
 
+// create a context for report generation
 const context = libReport.createContext({
-  dir: 'source/dir',
+  dir: 'report/output/dir',
   defaultSummarizer: 'summarizer name e.g. nested/flat/pkg',
   watermarks: configWatermarks,
   coverageMap,
 })
 
+// create an instance of the relevant report class
 const report = reports.create('report/name e.g. json/html/html-spa/text', {
   skipEmpty: configSkipEmpty,
   skipFull: configSkipFull
 })
+
+// call execute to synchronously create and write the report to disk
 report.execute(context)
 ```

From 14d6c9376fc829dfa422eada3e5635af169d3838 Mon Sep 17 00:00:00 2001
From: Luke Page <luke.a.page@gmail.com>
Date: Tue, 25 Jun 2019 22:08:13 +0200
Subject: [PATCH 3/3] Update based on comments.

---
 packages/istanbul-lib-report/README.md | 19 ++++++++++++++++---
 1 file changed, 16 insertions(+), 3 deletions(-)

diff --git a/packages/istanbul-lib-report/README.md b/packages/istanbul-lib-report/README.md
index 3ae32acd..f7ff56a3 100644
--- a/packages/istanbul-lib-report/README.md
+++ b/packages/istanbul-lib-report/README.md
@@ -11,16 +11,29 @@ Core reporting utilities for istanbul.
 const libReport = require('istanbul-lib-report');
 const reports = require('istanbul-reports');
 
+// coverageMap, for instance, obtained from istanbul-lib-coverage
+const coverageMap;
+
+const configWatermarks = {
+  statements: [50, 80],
+  functions: [50, 80],
+  branches: [50, 80],
+  lines: [50, 80]
+};
+
 // create a context for report generation
 const context = libReport.createContext({
   dir: 'report/output/dir',
-  defaultSummarizer: 'summarizer name e.g. nested/flat/pkg',
+  // The summarizer to default to (may be overridden by some reports)
+  // values can be nested/flat/pkg. Defaults to 'pkg'
+  defaultSummarizer: 'nested',
   watermarks: configWatermarks,
   coverageMap,
 })
 
-// create an instance of the relevant report class
-const report = reports.create('report/name e.g. json/html/html-spa/text', {
+// create an instance of the relevant report class, passing the
+// report name e.g. json/html/html-spa/text
+const report = reports.create('json', {
   skipEmpty: configSkipEmpty,
   skipFull: configSkipFull
 })