Skip to content

Commit 1bb083d

Browse files
authored
Add a note about not using postinstall to npm package developers (#105)
1 parent 1f2f03b commit 1bb083d

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,12 @@ module.exports = {
144144

145145
If you need to have multiple configuration files or just your-own configuration file, you install hooks manually from it by `npx simple-git-hooks ./my-config.js`.
146146

147+
### Note for `npm` package developers
148+
149+
Please do not add `postinstall: "npx simple-git-hooks"` script in your `package.json`. Or at least remove it before `npm publish`
150+
151+
It causes errors for end users of your package
152+
147153
### Uninstall simple-git-hooks
148154

149155
> Uninstallation will remove all the existing git hooks.

0 commit comments

Comments
 (0)