Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
typicode committed Mar 23, 2021
1 parent a77cfe2 commit cba924e
Showing 1 changed file with 22 additions and 10 deletions.
32 changes: 22 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,37 @@
Husky improves your commits and more 🐢 *woof!*

- [**Documentation v5 (recommended for Open Source and Sponsors)**](https://typicode.github.io/husky)
- [Documentation v4](https://github.com/typicode/husky/tree/v4)
- [**Documentation v5 - ❀️ 100% free for Open Source and recommended for Sponsors (🎁 non-sponsors can try it for 30-days)**](https://typicode.github.io/husky)
- [Documentation v4 - actively maintained and recommended for other projects](https://github.com/typicode/husky/tree/v4)

__πŸ‘‹ [Read husky 5 announcement and see what's new](https://dev.to/typicode/what-s-new-in-husky-5-32g5)__
__πŸ‘‹ [Jan 23, 2021: Read husky 5 announcement and see what's new](https://blog.typicode.com/husky-5/)__

__Note: husky 5 is a major version with breaking changes. Upgrading from v4 to v5 requires additional steps, please see the docs.__
Note: __husky 5 is a major version with breaking changes.__ Upgrading from v4 to v5 requires additional steps, please see the docs.

---
## License

You're viewing documentation for husky v5, which is free to use in Open Source projects ❀️ and in early access for Sponsors 🎁.
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) (monthly or yearly donations are supported).
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) (monthly or yearly donations are supported). __You can also try it for 30-days, no strings attached!__

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. During the early access, v4 will continue to receive maintainance updates.
__If you can't sponsor Husky, that's okay, [husky v4](https://github.com/typicode/husky/tree/master) is free for any project. During the early access, v4 will continue to receive maintainance updates.__

After the early access, husky v5 will be MIT again.

---
__As to why, I left my job to be able to work on Open Source. This will allow to compensate for the time on this release and fund new projects. Thank you for your understanding and support!__

__If you have any question about the temporary license, feel free to [email](https://github.com/typicode) me. I'll be happy to answer! :)__

__And once again, it's free for Open Source. Also since husky is a devDependency the license is limited to your project only.__

### Excuse

If you've mistakenly installed husky 5 at work, no worries. You're excused for unknowingly breaking the license and can try husky 5 for 30-days (see [LICENSE-PARITY](https://github.com/typicode/husky/blob/main/LICENSE-PARITY)).

# Sponsors

Many thanks to everyone who is funding my work! πŸ™

## Companies

<!-- for (let i = 0; i < 40; i++) console.log(`[![Husky Sponsor](https://opencollective.com/husky/backer/${i}/avatar)](https://opencollective.com/husky/backer/${i}/website)`) -->
Expand All @@ -42,9 +52,11 @@ After the early access, husky v5 will be MIT again.
<a href="https://opencollective.com/husky/tiers/sponsor/8/website"><img src="https://opencollective.com/husky/tiers/sponsor/8/avatar.svg" height="60px"></a>
<a href="https://opencollective.com/husky/tiers/sponsor/9/website"><img src="https://opencollective.com/husky/tiers/sponsor/9/avatar.svg" height="60px"></a>

[Become a sponsor](https://opencollective.com/husky/contribute/sponsor-9986/checkout)

## Individuals

Find Husky helpful? Become a backer and show your appreciation with a monthly donation on [Open Collective](https://opencollective.com/husky). You can also tip with a one-time donation.
Find Husky helpful? Become a sponsor and show your appreciation with a monthly donation on [Open Collective](https://opencollective.com/husky). You can also tip with a one-time donation.

[![Husky Sponsor](https://opencollective.com/husky/backer/0/avatar)](https://opencollective.com/husky/backer/0/website)
[![Husky Sponsor](https://opencollective.com/husky/backer/1/avatar)](https://opencollective.com/husky/backer/1/website)
Expand Down

0 comments on commit cba924e

Please sign in to comment.