From f226521f3214bcff7cf93c3a272c2e8e28826cba Mon Sep 17 00:00:00 2001 From: Tw93 Date: Sat, 4 Oct 2025 07:40:29 +0800 Subject: [PATCH] :sparkles: Update usage documentation --- README.md | 44 +++++++++++++++++++++++++++++--------------- 1 file changed, 29 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index b0e5d24..42c2464 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,17 @@

🦑 Dig deep like a mole to clean your Mac.

+

+ Stars + Version + License +

+ ## Highlights - 🐦 **Deep System Cleanup** - Remove hidden caches, logs, and temp files in one sweep -- πŸ“¦ **Smart Uninstall** - Complete app removal with all related files and folders -- ⚑️ **Fast Interactive UI** - Arrow-key navigation with pagination for large lists +- πŸ“¦ **Thorough Uninstall** - Removes more app leftovers than CleanMyMac/Lemon, completely free +- ⚑️ **Fast & Lightweight** - Terminal-based, zero bloat, arrow-key navigation with pagination - 🧹 **Massive Space Recovery** - Reclaim 100GB+ of wasted disk space ## Installation @@ -23,9 +29,7 @@ Or via Homebrew: brew install tw93/tap/mole ``` -> ⚠️ **Note:** Choose one installation method. Don't mix both to avoid conflicts. - -> πŸ“– **δΈδΌšη”¨η»ˆη«―οΌŸ** ζŸ₯ηœ‹ [ε°η™½δ½Ώη”¨ζŒ‡ε—](./GUIDE.md) δΊ†θ§£θ―¦η»†ηš„ζ•™η¨‹ +> Pick one method to avoid conflicts, new users check [ε°η™½δ½Ώη”¨ζŒ‡ε—](./GUIDE.md) ## Usage @@ -34,16 +38,11 @@ mole # Interactive main menu mole clean # Deep system cleanup mole clean --dry-run # Preview cleanup (no deletions) mole uninstall # Interactive app uninstaller +mole update # Update to latest version mole --help # Show help ``` -**Update:** -```bash -brew upgrade mole # If installed via Homebrew -mole update # If installed manually -``` - -**Navigation:** Use arrow keys (↑/↓), Space to select, Enter to confirm, Q to quit or Ctrl+C to force exit. +> Installed via Homebrew? Use `brew upgrade mole` to update ## Examples @@ -132,11 +131,26 @@ echo '~/Library/Caches/ms-playwright*' >> ~/.config/mole/whitelist | **Logs & Reports** | Crash reports & logs | `~/Library/Logs/AppName` | | **Containers** | Sandboxed app data | `~/Library/Containers/com.app.id` | +## FAQ + +**Q: Will Mole delete important files?** +A: No. Mole has built-in protection and skips system-critical files. + +**Q: Can I undo cleanup operations?** +A: Cache files regenerate automatically. For uninstalled apps, use Time Machine backup beforehand. + +**Q: How often should I run cleanup?** +A: Once a month is sufficient. Run when disk space is low. + +**Q: Is it safe to use?** +A: Yes. The tool previews what will be deleted before any action (`--dry-run`). + ## Support -- If Mole helps you recover disk space, star this repository and share with fellow Mac users. -- Report issues via [GitHub Issues](https://github.com/tw93/mole/issues). -- I have two cats, you can feed them canned food if you'd like. +- ⭐️ **Star this repo** if Mole helped you recover disk space +- πŸ› **Report issues** via [GitHub Issues](https://github.com/tw93/mole/issues) +- πŸ’¬ **Share with friends** who need to clean their Macs +- 🐱 I have two cats, feed them canned food if you'd like ## License