Skip to content

docs: add more details #1278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
louis-vinchon wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add more details #1278

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 11 additions & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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:
Expand Down