From 167264ad9e2856fd37a3b019e51888d7c5687b76 Mon Sep 17 00:00:00 2001 From: typicode Date: Thu, 4 Feb 2021 17:36:12 +0100 Subject: [PATCH] docs: update links --- README.md | 6 +++--- docs/README.md | 16 ++++++++++++---- 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 106d2b83b..a9d3cc638 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,11 @@ Husky improves your commits and more 🐶 *woof!* - [**Documentation v5 (recommended for Open Source and Sponsors)**](https://typicode.github.io/husky) -- [Documentation v4 (current latest)](https://github.com/typicode/husky/tree/master) +- [Documentation v4](https://github.com/typicode/husky/tree/master) -**Jan 23, 2021** - 👋 Read husky 5 announcement and see what's new: +__👋 Read husky 5 announcement and see what's new:__ -https://blog.typicode.com/husky-5 +https://dev.to/typicode/what-s-new-in-husky-5-32g5 --- diff --git a/docs/README.md b/docs/README.md index 3d0d09a99..59c47ddcb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,22 +2,26 @@ > Git hooks made easy -Husky improves your commits and more 🐶 *woof!* +Husky improves your commits and more 🐶 _woof!_ You can use it to lint your commit messages, run tests, lint code, etc... when you commit or push. Husky supports [all](https://git-scm.com/docs/githooks) Git hooks. +**👋 Read husky 5 announcement and see what's new:** + +https://dev.to/typicode/what-s-new-in-husky-5-32g5 + ?> You're viewing documentation for husky v5, which is free to use in Open Source projects ❤️ and in early access for Sponsors 🎁. To use this new version at work, you can become a sponsor on [GitHub Sponsors](https://github.com/sponsors/typicode) or [Open Collective](https://opencollective.com/husky).

If you can't sponsor Husky, that's okay, [husky v4](https://github.com/typicode/husky/tree/master) is free to use in any project. # Features - Zero dependencies -- Lightweight -- Fast +- Lightweight (`~0.02MB` vs `~1MB` for husky 4) +- Fast (`~0.01s` vs `~0.5s` for husky 4) - Supports macOS, Linux and Windows # Usage -_Already using husky? See [husky-4-to-5](https://github.com/typicode/husky-4-to-5) to quickly migrate from v4 to v5._ +_Already using husky? See [husky-4-to-5](https://github.com/typicode/husky-4-to-5) CLI to quickly migrate from v4 to v5._ ## Install @@ -181,7 +185,9 @@ If using [git-flow](https://github.com/petervanderdoes/gitflow-avh/) you need to ```shell git config gitflow.path.hooks .husky ``` + **Note:** + - If you are configuring git-flow _after_ you have installed Husky, the git-flow setup process will correctly suggest the .husky directory. - If you have set a [custom directory](#custom-directory) for Husky you need to specify that (ex. `git config gitflow.path.hooks .config/husky`) @@ -245,6 +251,8 @@ Environment variables: # Migrate from v4 to v5 +See [husky-4-to-5](https://github.com/typicode/husky-4-to-5) CLI to quickly migrate from v4 to v5. + ## Package scripts If you were calling `package.json` scripts using `npm` or `yarn`, **you can simply copy your commands**: