docs: add npx husky add workaround on Windows

typicode · Sep 13, 2021 · 3f19f5b · 3f19f5b
1 parent e134db1
commit 3f19f5b
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -76,6 +76,8 @@ For example:
 npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'
 ```
 
+_For Windows users, if you see the help message when running `npx husky add ...`, try `node node_modules/.bin/husky add ...` instead. This isn't an issue with husky code._
+
 ## Manual
 
 ### Install
@@ -130,6 +132,8 @@ If `npm test` command fails, your commit will be automatically aborted.
 
 !> **Using Yarn to run commands? There's an issue on Windows with Git Bash, see [Yarn on Windows](/?id=yarn-on-windows).**
 
+_For Windows users, if you see the help message when running `npx husky add ...`, try `node node_modules/.bin/husky add ...` instead. This isn't an issue with husky code._
+
 ### Uninstall
 
 ```shell