Update README.md

streetsidesoftware · May 14, 2019 · dee4185 · dee4185
1 parent 9878aeb
commit dee4185
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/packages/cspell/README.md b/packages/cspell/README.md
@@ -55,6 +55,25 @@ To get color in less, use `--color` and `less -r`
 cspell check <filename> --color | less -r
 ```
 
+## CI/CD Continuous Integration support
+
+### Git commit-hooks
+
+#### pre-commit
+
+**Setup**
+```
+npm install -SD cspell
+```
+
+**`.git/hooks/pre-commit`**
+```
+#!/bin/sh
+
+files=$(git diff --cached --name-only)
+exec npx cspell -- --no-summary $files
+```
+
 ## Requirements
 
 cspell needs Node 8 and above.