release: v0.2.0

fdionisi · Jan 7, 2022 · a6c803e · a6c803e
1 parent efa1b0b
commit a6c803e
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "captain-hook"
 description = "Cross-platform, modern and native git hooks."
-version = "0.1.2"
+version = "0.2.0"
 edition = "2018"
 authors = ["Federico Dionisi <code@fdionisi.me>"]
 readme = "README.md"

diff --git a/README.md b/README.md
@@ -21,6 +21,16 @@ despite the language or runtime available. The coding philosophy is to avoid
 dependencies to keep the size of the binary to a minimum, making it a CLI
 application that is accessible to anyone.
 
+## Notes
+
+- Upgrading from `0.1.*` to `0.2.0` involves breaking changes.
+  <details>
+
+  Version `0.2.0` is built on top of [husky](https://github.com/typicode/husky) and follows its files and directories naming convention.
+
+  During the `install` command, by default Captain Hook places all files in the `.husky` directory rather than the `.hooks`. The boot script for each hook is now called `_/husky.sh` instead of `_/captain-hook.sh`. Consequently, during the `add` command, the new hook will be prefixed with `. "$(dirname "$0")/_/husky.sh"`.
+  </details>
+
 ## Prerequisites
 
 To run `captain-hook` you need to have [git](https://git-scm.com/ "git")