From e468880d2ff7549e8940c097a9209ecdb8e7e66c Mon Sep 17 00:00:00 2001
From: Jason Dent <jason@streetsidesoftware.nl>
Date: Thu, 23 Jun 2022 09:06:56 -0700
Subject: [PATCH 1/2] fix: Update reporter README

Related to #3111
---
 packages/cspell-json-reporter/README.md | 22 ++++++++++++++++++----
 1 file changed, 18 insertions(+), 4 deletions(-)

diff --git a/packages/cspell-json-reporter/README.md b/packages/cspell-json-reporter/README.md
index b68fe1c1e63d..5e91393f53ef 100644
--- a/packages/cspell-json-reporter/README.md
+++ b/packages/cspell-json-reporter/README.md
@@ -2,14 +2,28 @@
 
 > CSpell reporter with JSON output
 
+## Installation
+
+Install it as a development package in the repository that will use it.
+
+```sh
+npm install -SD @cspell/cspell-json-reporter
+```
+
 ## Usage
 
-Add this to cSpell.json:
+Add this to `cspell.yaml`:
 
+```yaml
+reporters: [['@cspell/cspell-json-reporter', { outFile: 'out.json' }]]
 ```
-reporters: [
-    ['@cspell/cspell-json-reporter', { outFile: 'out.json' }]
-]
+
+or `cspell.json`
+
+```json
+{
+  "reporters": [["@cspell/cspell-json-reporter", { "outFile": "out.json" }]]
+}
 ```
 
 ## Output file format

From 12bec6f6e09a6408240e3f711fd9e0d77e395219 Mon Sep 17 00:00:00 2001
From: Jason Dent <jason@streetsidesoftware.nl>
Date: Thu, 23 Jun 2022 09:11:45 -0700
Subject: [PATCH 2/2] Update README.md

---
 packages/cspell-json-reporter/README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/packages/cspell-json-reporter/README.md b/packages/cspell-json-reporter/README.md
index 5e91393f53ef..c3ccb8ef9f77 100644
--- a/packages/cspell-json-reporter/README.md
+++ b/packages/cspell-json-reporter/README.md
@@ -37,7 +37,7 @@ or `cspell.json`
 - `info` - CSpell execution logs if `settings.verbose` is enabled
 - `debug` - CSpell debug logs if `settings.debug` is enabled
 
-See [CSpellJSONReporterOutput](src/CSpellJSONReporterOutput.ts) for more info.
+See [CSpellJSONReporterOutput](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-json-reporter/src/CSpellJSONReporterOutput.ts) for more info.
 
 ## Settings
 
@@ -48,4 +48,4 @@ Possible settings:
 - `debug` (default: false) - enable saving of debug logs
 - `progress` (default: false) - enable saving of file progress logs
 
-See [CSpellJSONReporterSettings](src/CSpellJSONReporterSettings.ts) for more info.
+See [CSpellJSONReporterSettings](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-json-reporter/src/CSpellJSONReporterSettings.ts) for more info.