diff --git a/README.md b/README.md index adfd3773f..e8639f8c2 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,9 @@ > Modern native Git hooks made easy -Husky improves your commits and more 🐶 *woof!* +Husky enables you to keep your git hooks version controlled along with your code. + +🐶 *woof!* # Install diff --git a/docs/index.md b/docs/index.md index 2868332e5..11b239d67 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,7 +6,9 @@ > Modern native git hooks made easy -Husky improves your commits and more 🐶 _woof!_ +Husky enables you to keep your git hooks version controlled along with your code. + +🐶 *woof!* You can use it to **lint your commit messages**, **run tests**, **lint code**, etc... when you commit or push. Husky supports [all Git hooks](https://git-scm.com/docs/githooks). @@ -26,6 +28,14 @@ Click [here](/getting-started) to get started. - Nested projects - Monorepos +## Husky vs vanilla Git hooks + +[By default](https://git-scm.com/docs/githooks), git hooks are read from the `.git/hooks/` directory. They are not version controlled and, +will not be propagated to your teammates when they clone the repository. + +Husky allows you to save your git hooks alongside your code, and it will automate the git +configuration for you. + ## Used by Husky is used by these awesome projects: