Skip to content

Commit 55c8349

Browse files
committed
docs: Update README with v1.0.0 installation instructions
- Add release badge - Update Homebrew installation (no longer 'Coming Soon') - Add direct download instructions for all platforms - Add verification section - Update roadmap with completed features - Add Features section highlighting key capabilities - Fix repository URLs
1 parent 3d082fa commit 55c8349

1 file changed

Lines changed: 62 additions & 7 deletions

File tree

README.md

Lines changed: 62 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
> 🧹 Clean development artifacts on macOS - free up disk space fast!
44
55
[![Go Version](https://img.shields.io/badge/Go-1.21+-00ADD8?style=flat-square&logo=go)](https://golang.org/)
6+
[![Release](https://img.shields.io/github/v/release/thanhdevapp/mac-dev-cleaner-cli?style=flat-square)](https://github.com/thanhdevapp/mac-dev-cleaner-cli/releases)
67
[![License](https://img.shields.io/badge/License-MIT-green?style=flat-square)](LICENSE)
78

89
## Overview
@@ -13,20 +14,65 @@ Mac Dev Cleaner is a CLI tool that helps developers reclaim disk space by removi
1314
- **Android** - Gradle caches, SDK caches
1415
- **Node.js** - node_modules, npm/yarn/pnpm/bun caches
1516

17+
## ✨ Features
18+
19+
- 🎯 **Smart Scanning** - Automatically detects development artifacts
20+
- 🎨 **Interactive TUI** - NCDU-style tree navigation with keyboard shortcuts
21+
- 🔒 **Safe by Default** - Dry-run mode prevents accidental deletions
22+
-**Multi-select** - Choose exactly what to delete with checkboxes
23+
- 🚀 **Fast & Efficient** - Scans thousands of directories in seconds
24+
- 📦 **Single Binary** - No dependencies, just download and run
25+
- 🌍 **Cross-platform** - Works on macOS and Linux (Intel & ARM64)
26+
1627
## Installation
1728

18-
### Homebrew (Coming Soon)
29+
### Homebrew (Recommended)
1930

2031
```bash
2132
brew tap thanhdevapp/tools
2233
brew install dev-cleaner
2334
```
2435

36+
### Direct Download
37+
38+
Download the latest release for your platform:
39+
40+
**macOS (Apple Silicon):**
41+
```bash
42+
curl -L https://github.com/thanhdevapp/mac-dev-cleaner-cli/releases/latest/download/dev-cleaner_darwin_arm64.tar.gz | tar xz
43+
sudo mv dev-cleaner /usr/local/bin/
44+
```
45+
46+
**macOS (Intel):**
47+
```bash
48+
curl -L https://github.com/thanhdevapp/mac-dev-cleaner-cli/releases/latest/download/dev-cleaner_darwin_amd64.tar.gz | tar xz
49+
sudo mv dev-cleaner /usr/local/bin/
50+
```
51+
52+
**Linux (ARM64):**
53+
```bash
54+
curl -L https://github.com/thanhdevapp/mac-dev-cleaner-cli/releases/latest/download/dev-cleaner_linux_arm64.tar.gz | tar xz
55+
sudo mv dev-cleaner /usr/local/bin/
56+
```
57+
58+
**Linux (x86_64):**
59+
```bash
60+
curl -L https://github.com/thanhdevapp/mac-dev-cleaner-cli/releases/latest/download/dev-cleaner_linux_amd64.tar.gz | tar xz
61+
sudo mv dev-cleaner /usr/local/bin/
62+
```
63+
64+
### Verify Installation
65+
66+
```bash
67+
dev-cleaner --version
68+
# Output: dev-cleaner version 1.0.0
69+
```
70+
2571
### From Source
2672

2773
```bash
28-
git clone https://github.com/thanhdevapp/dev-cleaner.git
29-
cd dev-cleaner
74+
git clone https://github.com/thanhdevapp/mac-dev-cleaner-cli.git
75+
cd mac-dev-cleaner-cli
3076
go build -o dev-cleaner .
3177
sudo mv dev-cleaner /usr/local/bin/
3278
```
@@ -117,11 +163,20 @@ go test ./...
117163

118164
## Roadmap
119165

166+
### Completed ✅
120167
- [x] MVP: Scan and clean commands
121-
- [ ] TUI with interactive selection (BubbleTea)
122-
- [ ] Config file support
123-
- [ ] Homebrew distribution
124-
- [ ] Progress bars
168+
- [x] TUI with interactive selection (Bubble Tea)
169+
- [x] NCDU-style tree navigation
170+
- [x] Homebrew distribution
171+
- [x] Cross-platform support (macOS, Linux)
172+
- [x] Multi-platform binaries (Intel, ARM64)
173+
174+
### Planned 🚀
175+
- [ ] Config file support (~/.dev-cleaner.yaml)
176+
- [ ] Progress bars for large operations
177+
- [ ] Wails GUI (v2.0.0)
178+
- [ ] Scheduled cleaning (cron integration)
179+
- [ ] Export reports (JSON/CSV)
125180

126181
## License
127182

0 commit comments

Comments
 (0)