Skip to content

Commit

Permalink
docs: add npx husky add workaround on Windows
Browse files Browse the repository at this point in the history
  • Loading branch information
typicode committed Sep 13, 2021
1 parent e134db1 commit 3f19f5b
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 3f19f5b

Please sign in to comment.