From 93f128202ad20eb6ebc57c7537dadddac051f558 Mon Sep 17 00:00:00 2001 From: typicode Date: Sat, 9 Mar 2024 11:23:19 +0100 Subject: [PATCH] docs: update index.md --- docs/index.md | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/docs/index.md b/docs/index.md index 8f3e64c5d..a9542e4e6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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) 💖 @@ -31,20 +49,6 @@ Support this project by becoming a sponsor [here](https://github.com/sponsors/ty -## 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: