btford · Jun 25, 2020 · Aug 11, 2020 · Aug 11, 2020
Showing with 12 additions and 4 deletions.

+1 −0 .npmignore

+7 −0 .pre-commit-hooks.yaml

+2 −2 README.md

+1 −1 package-lock.json

+1 −1 package.json
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1 @@
+.pre-commit-hooks.yaml
diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml
@@ -0,0 +1,7 @@
+---
+- id: write-good
+  name: write-good
+  description: Check docs for English prose with write-good
+  entry: write-good
+  language: node
+  files: "\\.(rst|md|markdown|mdown|mkdn)$"
diff --git a/README.md b/README.md
@@ -24,10 +24,10 @@ var suggestions = writeGood('So the cat was stolen.');
 // suggestions:
 //
 // [{
-//   suggestion: "omit 'So' from the beginning of sentences",
+//   reason: "omit 'So' from the beginning of sentences",
 //   index: 0, offset: 2
 // }, {
-//   suggestion: "'was stolen' is passive voice",
+//   reason: "'was stolen' is passive voice",
 //   index: 11, offset: 10
 // }]
 ```

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "write-good",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Naive linter for English prose",
   "main": "write-good.js",
   "repository": {