Skip to content

Commit c3a56b0

Browse files
committed
docs: Link INSTALL.md in README and add bash installer
- Update README.md with INSTALL.md link - Add one-line curl|bash installer to README and INSTALL.md - Update install.sh URL to use dev-mvp branch (current) - Fix build command path in README - Add note about future main branch migration
1 parent 1c24eb0 commit c3a56b0

File tree

4 files changed

+47
-7
lines changed

4 files changed

+47
-7
lines changed

.gitignore

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,10 @@ test-ck
6868
__pycache__
6969
prompt.md
7070

71-
# Go binary
72-
dev-cleaner
71+
# Go binary (CLI build output)
72+
/dev-cleaner
73+
dev-cleaner-test
74+
dev-cleaner-v*
7375

7476
# Gemini CLI settings (symlink to .claude/.mcp.json)
7577
.gemini/settings.json

INSTALL.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,30 @@ brew update
2525
brew upgrade dev-cleaner
2626
```
2727

28+
### One-Line Installer (macOS & Linux)
29+
30+
**Automatic installation:**
31+
```bash
32+
curl -fsSL https://raw.githubusercontent.com/thanhdevapp/mac-dev-cleaner-cli/dev-mvp/install.sh | bash
33+
```
34+
35+
**What it does:**
36+
- Detects your OS and architecture automatically
37+
- Downloads the latest release binary
38+
- Installs to `/usr/local/bin/`
39+
- Verifies installation
40+
41+
**Manual review before running:**
42+
```bash
43+
# View the script first
44+
curl -fsSL https://raw.githubusercontent.com/thanhdevapp/mac-dev-cleaner-cli/dev-mvp/install.sh
45+
46+
# Then run it
47+
curl -fsSL https://raw.githubusercontent.com/thanhdevapp/mac-dev-cleaner-cli/dev-mvp/install.sh | bash
48+
```
49+
50+
> **Note:** After migrating to `main` branch (see BRANCHING_STRATEGY.md), URLs will use `/main/` instead of `/dev-mvp/`
51+
2852
---
2953

3054
## Download Binaries

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,33 @@ Mac Dev Cleaner is a CLI tool that helps developers reclaim disk space by removi
2222

2323
## Installation
2424

25-
### Homebrew (Coming Soon)
25+
### Quick Install (Recommended)
2626

27+
**Homebrew:**
2728
```bash
2829
brew tap thanhdevapp/tools
2930
brew install dev-cleaner
3031
```
3132

32-
### From Source
33+
**One-line installer:**
34+
```bash
35+
curl -fsSL https://raw.githubusercontent.com/thanhdevapp/mac-dev-cleaner-cli/dev-mvp/install.sh | bash
36+
```
37+
38+
### More Options
39+
40+
See [INSTALL.md](INSTALL.md) for:
41+
- Direct binary downloads (macOS ARM/Intel, Linux)
42+
- Build from source instructions
43+
- GUI installation
44+
- Troubleshooting
45+
46+
### Quick Build from Source
3347

3448
```bash
35-
git clone https://github.com/thanhdevapp/dev-cleaner.git
36-
cd dev-cleaner
37-
go build -o dev-cleaner .
49+
git clone https://github.com/thanhdevapp/mac-dev-cleaner-cli.git
50+
cd mac-dev-cleaner-cli
51+
go build -o dev-cleaner ./cmd/dev-cleaner
3852
sudo mv dev-cleaner /usr/local/bin/
3953
```
4054

dev-cleaner-test

-396 KB
Binary file not shown.

0 commit comments

Comments
 (0)