Skip to content

Commit abc954a

Browse files
committed
docs: add cargo install instructions to README and website
1 parent c4e4936 commit abc954a

2 files changed

Lines changed: 31 additions & 4 deletions

File tree

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,19 @@ The folder still appears, but you get a clean file count instead of thousands of
3535

3636
## Installation
3737

38+
### Option 1: Install from crates.io
39+
The easiest way is to install directly via Cargo (make sure you have Rust installed):
40+
3841
```bash
39-
git clone https://github.com/caffienerd/struct-cli.git && cd struct-cli
42+
cargo install struct-cli
43+
```
44+
45+
View on [crates.io](https://crates.io/crates/struct-cli)
46+
47+
### Option 2: Install from source
48+
```
49+
git clone https://github.com/caffienerd/struct-cli.git
50+
cd struct-cli
4051
chmod +x install.sh && ./install.sh
4152
```
4253

@@ -427,4 +438,4 @@ Found a bug? Want a feature? Open an issue. PRs welcome.
427438

428439
## License
429440

430-
MIT
441+
MIT - feel free to do whatever you want with it!

docs/index.html

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -364,10 +364,26 @@ <h2 class="text-3xl sm:text-4xl font-bold text-white mb-4">Installation</h2>
364364
</div>
365365

366366
<div class="space-y-6">
367-
<!-- Manual Install -->
367+
<!-- Option 1: Install from crates.io -->
368368
<div class="rounded-xl overflow-hidden bg-[#161b22] border border-github-border terminal-shadow">
369369
<div class="flex items-center justify-between px-4 py-3 bg-[#0d1117] border-b border-github-border">
370-
<span class="text-sm text-github-muted font-mono">Manual Install</span>
370+
<span class="text-sm text-github-muted font-mono">Option 1: Install from crates.io</span>
371+
<button onclick="copyCode('cargo install struct-cli')" class="text-xs flex items-center gap-1 text-github-muted hover:text-github-accent transition-colors copy-btn">
372+
<i data-lucide="copy" class="w-3 h-3"></i>
373+
<span>Copy</span>
374+
</button>
375+
</div>
376+
<div class="p-4 font-mono text-sm space-y-1">
377+
<div class="text-github-muted mb-2">The easiest way is to install directly via Cargo (make sure you have Rust installed):</div>
378+
<div class="text-github-green">$ cargo install struct-cli</div>
379+
<div class="text-github-muted mt-3 text-xs">View on <a href="https://crates.io/crates/struct-cli" target="_blank" rel="noopener" class="text-github-accent hover:underline">crates.io</a></div>
380+
</div>
381+
</div>
382+
383+
<!-- Option 2: Install from source -->
384+
<div class="rounded-xl overflow-hidden bg-[#161b22] border border-github-border terminal-shadow">
385+
<div class="flex items-center justify-between px-4 py-3 bg-[#0d1117] border-b border-github-border">
386+
<span class="text-sm text-github-muted font-mono">Option 2: Install from source</span>
371387
<button onclick="copyCode('git clone https://github.com/caffienerd/struct-cli.git && cd struct-cli && chmod +x install.sh && ./install.sh')" class="text-xs flex items-center gap-1 text-github-muted hover:text-github-accent transition-colors copy-btn">
372388
<i data-lucide="copy" class="w-3 h-3"></i>
373389
<span>Copy</span>

0 commit comments

Comments
 (0)