Skip to content

Commit

Permalink
docs: update links
Browse files Browse the repository at this point in the history
  • Loading branch information
typicode committed Feb 4, 2021
1 parent e152640 commit 167264a
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 7 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

---

Expand Down
16 changes: 12 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).<br><br>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

Expand Down Expand Up @@ -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`)

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

0 comments on commit 167264a

Please sign in to comment.