diff --git a/.github/README.md b/.github/README.md index f31cedee..3e33e793 100644 --- a/.github/README.md +++ b/.github/README.md @@ -6,6 +6,24 @@ Husky improves your commits and more 🐶 _woof!_ +## 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 + ## Changelog [Check out the v9 changelog](https://github.com/typicode/husky/releases/tag/v9.0.1) to discover all the new and improved features!