Skip to content

Commit 31bc1e8

Browse files
Prot10Prot10
authored
Merge pull request #4 from Prot10/docs/add-screenshots-and-update-info
Docs/add screenshots and update info
2 parents 35e2ff0 + 9b29d72 commit 31bc1e8

17 files changed

Lines changed: 213 additions & 44 deletions

‎README.md‎

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,46 @@ MyMacCleaner is a free, open-source alternative to commercial Mac cleaning apps
3333

3434
## Screenshots
3535

36-
*Coming soon*
36+
### Home & Smart Scan
37+
<p align="center">
38+
<img src="website/public/screenshots/home/home_base.png" alt="Home Screen" width="45%">
39+
<img src="website/public/screenshots/home/home_full.png" alt="Smart Scan Results" width="45%">
40+
</p>
41+
42+
### Disk Cleaner & Space Lens
43+
<p align="center">
44+
<img src="website/public/screenshots/disk_cleaner/disk_cleaner_full.png" alt="Disk Cleaner" width="45%">
45+
<img src="website/public/screenshots/disk_cleaner/space_lens.png" alt="Space Lens" width="45%">
46+
</p>
47+
48+
### Performance & System Health
49+
<p align="center">
50+
<img src="website/public/screenshots/performance/performance.png" alt="Performance" width="45%">
51+
<img src="website/public/screenshots/system_health/system_health.png" alt="System Health" width="45%">
52+
</p>
53+
54+
### Applications & Port Management
55+
<p align="center">
56+
<img src="website/public/screenshots/applications/applications_full.png" alt="Applications" width="45%">
57+
<img src="website/public/screenshots/port_management/port_managment.png" alt="Port Management" width="45%">
58+
</p>
59+
60+
### Duplicates & Orphaned Files
61+
<p align="center">
62+
<img src="website/public/screenshots/duplicates/duplicates_full.png" alt="Duplicates" width="45%">
63+
<img src="website/public/screenshots/orphaned_files/orphaned_files_full.png" alt="Orphaned Files" width="45%">
64+
</p>
65+
66+
### Startup Items & Permissions
67+
<p align="center">
68+
<img src="website/public/screenshots/startup_items/startup_items_full.png" alt="Startup Items" width="45%">
69+
<img src="website/public/screenshots/permissions/permissions.png" alt="Permissions" width="45%">
70+
</p>
71+
72+
### Menu Bar Monitor
73+
<p align="center">
74+
<img src="website/public/screenshots/menu/menu.png" alt="Menu Bar" width="30%">
75+
</p>
3776

3877
## Requirements
3978

@@ -104,13 +143,17 @@ See [Permissions Guide](docs/permissions.md) for detailed information.
104143
- [Menu Bar Monitor](docs/menu-bar.md)
105144
- [Permissions Guide](docs/permissions.md)
106145

146+
## Automatic Updates
147+
148+
MyMacCleaner includes built-in automatic update checking powered by the Sparkle framework. The app periodically checks for new versions in the background, and when an update is available, a notification button appears next to the language switcher in the app toolbar. This provides a seamless update experience - simply click the button to download and install the latest version without leaving the app.
149+
107150
## Tech Stack
108151

109152
- **Language**: Swift 5.9+
110153
- **UI Framework**: SwiftUI
111154
- **Design**: Apple Liquid Glass (macOS Tahoe style)
112155
- **Concurrency**: Swift async/await, TaskGroups
113-
- **Updates**: Sparkle Framework
156+
- **Updates**: Sparkle Framework (automatic background checks with in-app notification)
114157

115158
## Attribution
116159

‎docs/applications.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
Complete application management: uninstall apps properly and check for updates.
44

5+
![Applications - Before Analysis](/MyMacCleaner/screenshots/applications/applications_base.png)
6+
*Applications Manager ready to analyze your installed apps*
7+
58
## Overview
69

710
The Applications Manager helps you:
@@ -12,6 +15,9 @@ The Applications Manager helps you:
1215

1316
## Application List
1417

18+
![Applications - Full List](/MyMacCleaner/screenshots/applications/applications_full.png)
19+
*Grid view showing all installed applications with size and update status*
20+
1521
### Views
1622

1723
- **Grid View** - Visual display with app icons
@@ -85,6 +91,10 @@ MyMacCleaner scans for all related files before uninstalling.
8591

8692
## Update Checker
8793

94+
### Automatic Update Notifications
95+
96+
MyMacCleaner itself automatically checks for updates in the background using the Sparkle framework. When a new version is available, an update notification button appears next to the language switcher in the app toolbar. This seamless experience lets you update the app without interrupting your workflow - simply click the button to download and install the latest version.
97+
8898
### Supported Update Sources
8999

90100
| Source | Detection Method |

‎docs/disk-cleaner.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,16 @@
22

33
Deep cleaning functionality to remove junk files and free up disk space.
44

5+
![Disk Cleaner - Before Scan](/MyMacCleaner/screenshots/disk_cleaner/disk_cleaner_base.png)
6+
*Disk Cleaner ready to scan for junk files*
7+
58
## Overview
69

710
Disk Cleaner provides granular control over what gets cleaned, with detailed categories and safe deletion practices.
811

12+
![Disk Cleaner - Scan Results](/MyMacCleaner/screenshots/disk_cleaner/disk_cleaner_full.png)
13+
*Detailed scan results showing all cleanable categories*
14+
915
## Categories
1016

1117
### System Junk
@@ -59,6 +65,9 @@ Web browser caches and data.
5965

6066
The Browser Privacy tab provides deep cleaning of browser data for enhanced privacy.
6167

68+
![Browser Privacy](/MyMacCleaner/screenshots/disk_cleaner/privacy.png)
69+
*Browser Privacy tab for deep cleaning browser data*
70+
6271
### Supported Browsers
6372

6473
| Browser | Supported |

‎docs/duplicates.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,16 @@
22

33
Find and remove duplicate files to reclaim wasted disk space.
44

5+
![Duplicates - Before Scan](/MyMacCleaner/screenshots/duplicates/duplicates_base.png)
6+
*Duplicate Finder ready to scan for duplicate files*
7+
58
## Overview
69

710
The Duplicate Finder scans your folders for exact duplicate files using SHA256 hashing. It identifies files with identical content regardless of their names or locations, helping you safely remove redundant copies.
811

12+
![Duplicates - Results](/MyMacCleaner/screenshots/duplicates/duplicates_full.png)
13+
*Scan results showing duplicate file groups with statistics*
14+
915
## How It Works
1016

1117
The scanner uses a multi-stage process optimized for speed and accuracy:

‎docs/home.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
The Home screen is your dashboard for quick system overview and one-click cleanup.
44

5+
![Home Screen - Before Scan](/MyMacCleaner/screenshots/home/home_base.png)
6+
*Home screen with Smart Scan ready to analyze your system*
7+
58
## Overview
69

710
When you open MyMacCleaner, the Home screen provides:
@@ -49,6 +52,9 @@ After scanning, you'll see:
4952
- Individual items you can select/deselect
5053
- Safety indicators for each item
5154

55+
![Home Screen - After Scan](/MyMacCleaner/screenshots/home/home_full.png)
56+
*Scan results showing cleanable categories and total space to recover*
57+
5258
## Quick Actions
5359

5460
Shortcuts to common tasks:

‎docs/menu-bar.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
Monitor your Mac's performance at a glance from the menu bar.
44

5+
![Menu Bar](/MyMacCleaner/screenshots/menu/menu.png)
6+
*Menu Bar popover showing CPU, Memory, and Disk stats with quick actions*
7+
58
## Overview
69

710
The Menu Bar Monitor provides real-time CPU and RAM monitoring directly in your menu bar. Click to see detailed stats and quick actions without opening the full app.

‎docs/orphaned-files.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,16 @@
22

33
Detect and remove leftover files from applications that have been uninstalled.
44

5+
![Orphaned Files - Before Scan](/MyMacCleaner/screenshots/orphaned_files/orphaned_files_base.png)
6+
*Orphaned Files scanner ready to detect leftover files*
7+
58
## Overview
69

710
When you delete an application by dragging it to the Trash, many associated files remain on your system. These "orphaned files" can accumulate over time, taking up valuable disk space. The Orphaned Files scanner identifies these remnants and helps you safely remove them.
811

12+
![Orphaned Files - Results](/MyMacCleaner/screenshots/orphaned_files/orphaned_files_full.png)
13+
*Scan results showing orphaned files grouped by category*
14+
915
## What Are Orphaned Files?
1016

1117
Orphaned files are support files that were created by applications but remain after the app is uninstalled. They include:

‎docs/performance.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
System optimization tools and maintenance tasks.
44

5+
![Performance](/MyMacCleaner/screenshots/performance/performance.png)
6+
*Performance dashboard showing memory usage, processes, and maintenance options*
7+
58
## Overview
69

710
The Performance section provides tools to optimize your Mac's speed and responsiveness through memory management and system maintenance.

‎docs/permissions.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
Understanding and managing permissions for MyMacCleaner.
44

5+
![Permissions](/MyMacCleaner/screenshots/permissions/permissions.png)
6+
*Permissions management page showing folder access status*
7+
58
## Overview
69

710
MyMacCleaner needs certain permissions to access system files and perform cleanup operations. This guide explains what permissions are needed, why, and how to grant them.

‎docs/port-management.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
View and manage processes using network ports.
44

5+
![Port Management](/MyMacCleaner/screenshots/port_management/port_managment.png)
6+
*Port Management showing active network connections and listening ports*
7+
58
## Overview
69

710
Port Management helps developers and power users see what's running on their Mac's network ports and terminate processes when needed.

0 commit comments

Comments
 (0)