Skip to content

Commit

Permalink
docs: update index.md
Browse files Browse the repository at this point in the history
  • Loading branch information
typicode committed Mar 9, 2024
1 parent ad6f0b3 commit 93f1282
Showing 1 changed file with 18 additions and 14 deletions.
32 changes: 18 additions & 14 deletions docs/index.md
Expand Up @@ -10,6 +10,24 @@ Get started [here](/get-started.md).

[Check out the v9 changelog](https://github.com/typicode/husky/releases/tag/v9.0.1) to discover all the new and improved features! 🚀

## Features

- Just `2 kB` (📦 _gzipped_) with no dependencies
- Extremely fast (runs in `~1ms`)
- Uses new Git feature (`core.hooksPath`)
- - Supports:
- macOS, Linux, Windows
- Git GUIs, Node version managers, custom hooks directory, nested projects, monorepos
- [All 13 client-side Git hooks](https://git-scm.com/docs/githooks)

And more:
- Branch-specific hooks
- Use POSIX shell to script advanced cases
- Adheres to Git's native hook organization
- Aligns with [npm](https://docs.npmjs.com/cli/v10/using-npm/scripts#best-practices) best practices using `prepare` script
- Opt-in/opt-out options
- User-friendly error messages

## Sponsors

Support this project by becoming a sponsor [here](https://github.com/sponsors/typicode) 💖
Expand All @@ -31,20 +49,6 @@ Support this project by becoming a sponsor [here](https://github.com/sponsors/ty
<a href="https://opencollective.com/husky/tiers/company/4/website"><img src="https://opencollective.com/husky/tiers/company/4/avatar.svg?avatarHeight=120"></a>
<a href="https://opencollective.com/husky/tiers/company/5/website"><img src="https://opencollective.com/husky/tiers/company/5/avatar.svg?avatarHeight=120"></a>

## Features

- Just `2 kB` (📦 _gzipped_) with no dependencies
- Uses new Git feature (`core.hooksPath`)
- Adheres to Git's native hook organization
- Aligns with [npm](https://docs.npmjs.com/cli/v10/using-npm/scripts#best-practices) best practices using `prepare` script
- Clear user messages
- Opt-in/opt-out options
- Branch-specific hooks
- Supports:
- macOS, Linux, Windows
- Git GUIs, Node version managers, custom hooks directory, nested projects, monorepos
- [All 13 client-side Git hooks](https://git-scm.com/docs/githooks)

## Used by

Husky is used in [**over 1.3M projects**](https://github.com/typicode/husky/network/dependents?package_id=UGFja2FnZS0xODQzNTgwNg%3D%3D) on GitHub, including:
Expand Down

0 comments on commit 93f1282

Please sign in to comment.