Skip to content

Commit 915d8dd

Browse files
committed
docs: improve installation instructions
- Enhance readability of installation section - Add clear comments for different installation methods - Maintain original installation options - Improve code block formatting
1 parent e3f70ac commit 915d8dd

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

+13-4
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,20 @@
1616

1717
## Quick Start
1818

19-
1. Add to your `Cargo.toml`:
19+
1. Adding `husky-rs` to your project:
2020

21-
```toml
22-
[dev-dependencies]
23-
husky-rs = "0.1.2"
21+
You have several options:
22+
23+
```sh
24+
# Option 1: Add as a Regular Dependency
25+
cargo add husky-rs
26+
27+
# Option 2: Add as a Dev Dependency
28+
cargo add --dev husky-rs
29+
30+
# Option 3: Use the Main Branch
31+
cargo add --git https://github.com/pplmx/husky-rs --branch main
32+
cargo add --dev --git https://github.com/pplmx/husky-rs --branch main
2433
```
2534

2635
2. Create hooks directory:

0 commit comments

Comments
 (0)