Skip to content

Commit aab71b0

Browse files
committed
docs: update installation section with multiple methods
- Add cargo-binstall as recommended method - Add GitHub releases download option - Update crates.io installation command - Improve source build instructions
1 parent 6f4bd87 commit aab71b0

1 file changed

Lines changed: 23 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,34 @@ A tiny Rust-based CLI tool to generate unique IDs, primarily UUIDs. Built as a m
1414

1515
## Installation
1616

17+
### With cargo-binstall (recommended)
18+
19+
The fastest way to install pre-built binaries:
20+
1721
```bash
18-
cargo install --path .
22+
cargo binstall mkid
23+
```
24+
25+
### From GitHub releases
26+
27+
Download pre-built binaries directly from [GitHub releases](https://github.com/asaaki/mkid/releases).
28+
29+
### From crates.io
30+
31+
Build from source via crates.io:
32+
33+
```bash
34+
cargo install mkid --locked
1935
```
2036

21-
Or build from source:
37+
### From source
38+
39+
Build from the repository:
2240

2341
```bash
24-
cargo build --release
25-
# Binary available at target/release/mkid
42+
git clone https://github.com/asaaki/mkid
43+
cd mkid
44+
cargo install --path .
2645
```
2746

2847
## Usage

0 commit comments

Comments
 (0)