Skip to content

Commit 06b59a9

Browse files
committed
docs: add GUI app screenshots and features to README
- Added GUI app screenshot section - Highlighted GUI features (native UI, multiple views, treemap, etc.) - Reorganized installation section (GUI first, then CLI) - Added direct DMG download links - Moved screenshots to screens/ directory - Updated README structure for better clarity Screenshot showcases: - Dark mode interface - Category sidebar (All Items, Xcode, Android, Node.js, etc.) - Table view with sortable columns - Interactive treemap visualization - Total: 11.32 GB cleanable from 49 items
1 parent e931574 commit 06b59a9

File tree

4 files changed

+33
-5
lines changed

4 files changed

+33
-5
lines changed

README.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1-
# Mac Dev Cleaner CLI
1+
# Mac Dev Cleaner
22

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/)
66
[![License](https://img.shields.io/badge/License-MIT-green?style=flat-square)](LICENSE)
77

8+
**Available as both CLI and beautiful native GUI app!**
9+
810
## Overview
911

10-
Mac Dev Cleaner is a CLI tool that helps developers reclaim disk space by removing:
12+
Mac Dev Cleaner helps developers reclaim disk space by removing:
1113

1214
- **Xcode** - DerivedData, Archives, Caches
1315
- **Android** - Gradle caches, SDK caches
@@ -20,9 +22,35 @@ Mac Dev Cleaner is a CLI tool that helps developers reclaim disk space by removi
2022
- **Docker** - unused images, containers, volumes, build cache
2123
- **Java/Kotlin** - Maven .m2, Gradle caches, build directories
2224

25+
## Screenshots
26+
27+
### GUI App
28+
29+
![Mac Dev Cleaner GUI](screens/image.png)
30+
31+
**Features:**
32+
- 🎨 **Beautiful Native Interface** - Modern dark mode UI built with Wails
33+
- 📊 **Multiple Views** - Switch between List, Treemap, and Split view
34+
- 🔍 **Smart Categorization** - Filter by development ecosystem (Xcode, Android, Node.js, etc.)
35+
- 📈 **Visual Size Analysis** - Interactive treemap shows space usage at a glance
36+
-**Real-time Scan** - Fast parallel scanning with progress indicators
37+
- 🎯 **Selective Cleaning** - Pick exactly what to delete with checkboxes
38+
- 💾 **Safe Deletion** - Confirmation dialogs prevent accidents
39+
- 🔄 **Auto-Update** - Check for new versions automatically
40+
41+
**Download DMG:**
42+
- [Apple Silicon (M1/M2/M3)](https://github.com/thanhdevapp/mac-dev-cleaner-cli/releases/latest/download/mac-dev-cleaner-darwin-arm64.dmg)
43+
- [Intel](https://github.com/thanhdevapp/mac-dev-cleaner-cli/releases/latest/download/mac-dev-cleaner-darwin-amd64.dmg)
44+
2345
## Installation
2446

25-
### Quick Install (Recommended)
47+
### GUI App (Recommended for Most Users)
48+
49+
Download and install the native app:
50+
- [Apple Silicon DMG](https://github.com/thanhdevapp/mac-dev-cleaner-cli/releases/latest/download/mac-dev-cleaner-darwin-arm64.dmg)
51+
- [Intel DMG](https://github.com/thanhdevapp/mac-dev-cleaner-cli/releases/latest/download/mac-dev-cleaner-darwin-amd64.dmg)
52+
53+
### CLI Tool
2654

2755
**Homebrew:**
2856
```bash
@@ -40,7 +68,7 @@ curl -fsSL https://raw.githubusercontent.com/thanhdevapp/mac-dev-cleaner-cli/dev
4068
See [INSTALL.md](INSTALL.md) for:
4169
- Direct binary downloads (macOS ARM/Intel, Linux)
4270
- Build from source instructions
43-
- GUI installation
71+
- Advanced configuration
4472
- Troubleshooting
4573

4674
### Quick Build from Source
@@ -52,7 +80,7 @@ go build -o dev-cleaner ./cmd/dev-cleaner
5280
sudo mv dev-cleaner /usr/local/bin/
5381
```
5482

55-
## Usage
83+
## CLI Usage
5684

5785
### Scan for Cleanable Items
5886

screens/image.png

207 KB
Loading
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)