Skip to content

Commit 78bf94a

Browse files
committed
Enhance README.md with updated project description, features, and tech stack. Add icons and badges for better visibility. Improve formatting and clarity of sections, including Quick Start and Safety information.
1 parent 3e50402 commit 78bf94a

1 file changed

Lines changed: 121 additions & 91 deletions

File tree

README.md

Lines changed: 121 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1,189 +1,213 @@
11
<div align="center">
22

3+
<br>
4+
5+
<img src="src-tauri/icons/icon.png" width="100" alt="System Health Tool icon">
6+
7+
<br>
8+
39
# System Health Tool
410

5-
**A lightweight Windows desktop app that scans, diagnoses, and cleans up system issues.**
11+
### Keep your Windows PC fast, clean, and healthy.
12+
13+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](LICENSE)
14+
[![Tauri 2](https://img.shields.io/badge/Tauri-2-blue?style=flat-square&logo=tauri&logoColor=white)](https://v2.tauri.app)
15+
[![React 19](https://img.shields.io/badge/React-19-61dafb?style=flat-square&logo=react&logoColor=white)](https://react.dev)
16+
[![Rust](https://img.shields.io/badge/Rust-Backend-orange?style=flat-square&logo=rust&logoColor=white)](https://www.rust-lang.org)
17+
[![TypeScript](https://img.shields.io/badge/TypeScript-5.9-3178c6?style=flat-square&logo=typescript&logoColor=white)](https://www.typescriptlang.org)
618

7-
Designed for people who aren't technical.
19+
<br>
820

9-
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
10-
[![Tauri](https://img.shields.io/badge/Tauri-2-blue?logo=tauri&logoColor=white)](https://v2.tauri.app)
11-
[![React](https://img.shields.io/badge/React-19-61dafb?logo=react&logoColor=white)](https://react.dev)
12-
[![Rust](https://img.shields.io/badge/Rust-Backend-orange?logo=rust&logoColor=white)](https://www.rust-lang.org)
13-
[![TypeScript](https://img.shields.io/badge/TypeScript-5.9-3178c6?logo=typescript&logoColor=white)](https://www.typescriptlang.org)
21+
`~2.5 MB installer` &nbsp;·&nbsp; `No bloat` &nbsp;·&nbsp; `No telemetry` &nbsp;·&nbsp; `Open source`
1422

15-
`2.5 MB installer` · `No bloat` · `No telemetry` · `Open source`
23+
<br>
24+
25+
<!-- TODO: Replace with actual screenshot once published -->
26+
<!-- <img src="docs/assets/screenshot.png" width="720" alt="App screenshot"> -->
1627

1728
---
1829

1930
</div>
2031

32+
<br>
33+
34+
## Overview
35+
36+
A lightweight, open-source Windows desktop app that scans, diagnoses, and cleans up system issues — designed for people who aren't technical. Built with **React** on the frontend and **Rust** on the backend via [Tauri 2](https://v2.tauri.app), it's fast, tiny, and runs natively with no Electron bloat.
37+
38+
<br>
39+
2140
## Features
2241

2342
<table>
2443
<tr>
25-
<td width="50%">
44+
<td width="50%" valign="top">
2645

27-
### Dashboard
46+
#### &nbsp;&nbsp;📊&nbsp;&nbsp;Dashboard
2847
Real-time health score (0–100), drive space bars, RAM usage donut chart, and a one-click **Quick Clean** button that only touches safe items.
2948

3049
</td>
31-
<td width="50%">
50+
<td width="50%" valign="top">
3251

33-
### Disk Cleanup
52+
#### &nbsp;&nbsp;🧹&nbsp;&nbsp;Disk Cleanup
3453
Scans temp files, browser caches, crash dumps, dev caches, and the recycle bin. Every item has a color-coded risk label so you know exactly what's safe to delete.
3554

3655
</td>
3756
</tr>
3857
<tr>
39-
<td width="50%">
58+
<td width="50%" valign="top">
4059

41-
### Memory & Processes
60+
#### &nbsp;&nbsp;🧠&nbsp;&nbsp;Memory & Processes
4261
See what's eating your RAM, spot runaway processes, detect Hyper-V and WSL virtual machines hogging memory. Kill non-system processes directly.
4362

4463
</td>
45-
<td width="50%">
64+
<td width="50%" valign="top">
4665

47-
### Startup Manager
66+
#### &nbsp;&nbsp;&nbsp;&nbsp;Startup Manager
4867
Toggle startup programs on/off with impact ratings (High / Medium / Low) and "recommended to disable" badges. Nothing is uninstalled — just toggled.
4968

5069
</td>
5170
</tr>
5271
<tr>
53-
<td colspan="2">
72+
<td colspan="2" valign="top">
5473

55-
### Smart Recommendations
56-
Auto-generated tips like *"Your pagefile is on a full drive"* or *"6 apps launch at startup"* — each with a **Fix It** button that navigates to the right panel.
74+
#### &nbsp;&nbsp;💡&nbsp;&nbsp;Smart Recommendations
75+
Auto-generated tips like *"Your pagefile is on a full drive"* or *"6 apps launch at startup"* — each with a **Fix It** button that navigates directly to the right panel.
5776

5877
</td>
5978
</tr>
6079
</table>
6180

81+
<br>
82+
6283
## Quick Start
6384

6485
### Download
6586

66-
Grab the latest installer from the [**Releases**](https://github.com/TMHSDigital/system-cleaner/releases) page:
87+
Grab the latest installer from [**Releases**](https://github.com/TMHSDigital/system-cleaner/releases):
6788

6889
| Format | Size | Notes |
6990
|--------|------|-------|
7091
| `System Cleaner_x.x.x_x64-setup.exe` | ~2.5 MB | NSIS installer (recommended) |
7192
| `System Cleaner_x.x.x_x64_en-US.msi` | ~3.8 MB | MSI installer |
7293

73-
Or grab the standalone `.exe` from the release — no install required.
74-
7594
> [!NOTE]
76-
> The app requests admin privileges on launch. This is needed for system-level operations like clearing Windows temp files, managing services, and reading all processes.
95+
> The app requests admin privileges on launchneeded for clearing Windows temp files, managing services, and reading all processes.
7796
78-
### Build From Source
97+
### Build from source
7998

80-
**Prerequisites:** [Node.js](https://nodejs.org/) 18+ · [Rust](https://rustup.rs/) 1.85+ · Windows 10/11 with [WebView2](https://developer.microsoft.com/en-us/microsoft-edge/webview2/)
99+
**Prerequisites:** [Node.js](https://nodejs.org/) 18+ &nbsp;·&nbsp; [Rust](https://rustup.rs/) 1.85+ &nbsp;·&nbsp; Windows 10/11 with [WebView2](https://developer.microsoft.com/en-us/microsoft-edge/webview2/)
81100

82101
```bash
83102
git clone https://github.com/TMHSDigital/system-cleaner.git
84103
cd system-cleaner
85104
npm install
86105

87-
# Dev mode (hot reload)
88-
npm run tauri:dev
89-
90-
# Production build
91-
npm run tauri:build
106+
npm run tauri:dev # dev mode with hot reload
107+
npm run tauri:build # production build → src-tauri/target/release/bundle/
92108
```
93109

94-
Build output: `src-tauri/target/release/bundle/`
110+
<br>
95111

96112
## Tech Stack
97113

98-
<div align="center">
99-
100114
| Layer | Technology |
101115
|-------|-----------|
102116
| **Frontend** | React 19 · TypeScript 5.9 · Tailwind CSS v4 · Recharts |
103117
| **Backend** | Tauri 2 (Rust) — native Win32 & registry access via `tauri::command` |
104118
| **Bundler** | Vite 7 |
105119
| **Icons** | Lucide React |
106120

107-
</div>
121+
<br>
108122

109123
## Architecture
110124

111125
```
112-
┌─────────────────────────────────────────────────┐
113-
│ Tauri Window │
114-
│ ┌───────────────────────────────────────────┐ │
115-
│ │ React Frontend │ │
116-
│ │ Dashboard · Disk · Memory · Startup · Tips│ │
117-
│ │ ↕ api.ts │ │
118-
│ └───────────────────┬───────────────────────┘ │
119-
│ │ IPC (JSON) │
120-
│ ┌───────────────────┴───────────────────────┐ │
121-
│ │ Rust Backend (Tauri 2) │ │
122-
│ │ disk.rs · memory.rs · startup.rs │ │
123-
│ │ cleanup.rs · recommendations.rs │ │
124-
│ └───────────────────────────────────────────┘ │
125-
└──────────┬───────────────┬───────────────┬──────┘
126-
Win32 API PowerShell Registry
126+
┌──────────────────────────────────────────────────────┐
127+
│ Tauri Window │
128+
│ │
129+
│ ┌────────────────────────────────────────────────┐ │
130+
│ │ React Frontend │ │
131+
│ │ Dashboard · Disk · Memory · Startup · Tips │ │
132+
│ │ ↕ api.ts │ │
133+
│ └────────────────────┬───────────────────────────┘ │
134+
│ │ IPC (JSON) │
135+
│ ┌────────────────────┴───────────────────────────┐ │
136+
│ │ Rust Backend (Tauri 2) │ │
137+
│ │ disk.rs · memory.rs · startup.rs │ │
138+
│ │ cleanup.rs · recommendations.rs │ │
139+
│ └────────────────────────────────────────────────┘ │
140+
│ │
141+
└─────────┬────────────────┬────────────────┬──────────┘
142+
Win32 API PowerShell Registry
127143
```
128144

129145
> Full architecture docs: [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md)
130146
147+
<br>
148+
149+
## Safety
150+
151+
> [!IMPORTANT]
152+
> No files are ever deleted without showing you exactly what will happen first.
153+
154+
Every cleanable item is categorized by risk:
155+
156+
| Level | Meaning | Examples |
157+
|-------|---------|----------|
158+
| 🟢 **Safe** | Always fine to delete — regenerated automatically | Temp files, browser caches, crash dumps |
159+
| 🟡 **Moderate** | Re-downloaded when needed | Dev caches (npm, pip, cargo), Windows Update files |
160+
| 🔴 **Advanced** | Requires explicit confirmation | Reserved for future features |
161+
162+
- **Quick Clean** only touches Safe items
163+
- Moderate / Advanced items must be manually selected in the Disk Cleanup tab
164+
- Locked files are silently skipped — no errors, no data loss
165+
- System processes cannot be killed from the Memory tab
166+
167+
> Full safety details: [`docs/SAFETY.md`](docs/SAFETY.md)
168+
169+
<br>
170+
131171
## Project Structure
132172

133173
```
134174
system-cleaner/
135-
├── src/ # React frontend
136-
│ ├── App.tsx # Sidebar nav + tab routing
175+
├── src/ # React frontend
176+
│ ├── App.tsx # Sidebar nav + tab routing
137177
│ ├── components/
138-
│ │ ├── Dashboard.tsx # Health score, drives, RAM, Quick Clean
139-
│ │ ├── DiskCleanup.tsx # Scan → Review → Clean workflow
140-
│ │ ├── MemoryPanel.tsx # RAM chart, processes, VM detection
141-
│ │ ├── StartupManager.tsx # Toggle switches + impact ratings
142-
│ │ └── Recommendations.tsx # Auto-tips with Fix It navigation
143-
│ └── lib/
144-
│ ├── api.ts # Typed Tauri invoke() wrappers
145-
│ ├── types.ts # Shared interfaces
146-
│ └── format.ts # Byte/percent formatting
147-
├── src-tauri/ # Rust backend
178+
│ │ ├── Dashboard.tsx # Health score, drives, RAM, Quick Clean
179+
│ │ ├── DiskCleanup.tsx # Scan → Review → Clean workflow
180+
│ │ ├── MemoryPanel.tsx # RAM chart, processes, VM detection
181+
│ │ ├── StartupManager.tsx # Toggle switches + impact ratings
182+
│ │ └── Recommendations.tsx # Auto-tips with Fix It navigation
183+
│ ├── lib/
184+
│ │ ├── api.ts # Typed Tauri invoke() wrappers
185+
│ │ ├── types.ts # Shared interfaces
186+
│ │ └── format.ts # Byte/percent formatting
187+
│ └── styles/
188+
│ └── tokens.css # Design tokens + component classes
189+
├── src-tauri/ # Rust backend
148190
│ ├── src/
149-
│ │ ├── lib.rs # Tauri bootstrap + command registration
150-
│ │ ├── main.rs # Windows entry point
191+
│ │ ├── lib.rs # Tauri bootstrap + command registration
192+
│ │ ├── main.rs # Windows entry point
151193
│ │ └── commands/
152-
│ │ ├── disk.rs # Drive info, temp/cache/browser scanning
153-
│ │ ├── memory.rs # RAM stats, process list, VM detection
154-
│ │ ├── startup.rs # Registry + folder startup management
155-
│ │ ├── cleanup.rs # Safe deletion with progress tracking
156-
│ │ └── recommendations.rs
194+
│ │ ├── disk.rs # Drive info, temp/cache scanning
195+
│ │ ├── memory.rs # RAM stats, process list, VM detection
196+
│ │ ├── startup.rs # Registry + folder startup management
197+
│ │ ├── cleanup.rs # Safe deletion with progress tracking
198+
│ │ └── recommendations.rs # Auto-generated system tips
157199
│ ├── tauri.conf.json
158200
│ └── Cargo.toml
159201
├── docs/
160-
│ ├── ARCHITECTURE.md # How it works internally
161-
│ ├── SAFETY.md # Risk levels & what gets deleted
162-
│ └── CONTRIBUTING.md # How to contribute
202+
│ ├── ARCHITECTURE.md
203+
│ ├── SAFETY.md
204+
│ └── CONTRIBUTING.md
163205
├── package.json
164206
├── vite.config.ts
165207
└── tsconfig.json
166208
```
167209

168-
## Safety
169-
170-
> [!IMPORTANT]
171-
> No files are ever deleted without showing you exactly what will happen first.
172-
173-
Every cleanable item is categorized by risk:
174-
175-
| Level | Color | Examples | What Happens |
176-
|-------|-------|----------|-------------|
177-
| **Safe** | Green | Temp files, browser caches, crash dumps | Always fine to delete — regenerated automatically |
178-
| **Moderate** | Yellow | Dev caches (npm, pip, cargo), Windows Update files | Re-downloaded when needed |
179-
| **Advanced** | Red | Reserved for future features | Requires explicit confirmation |
180-
181-
- **Quick Clean** only touches Safe items
182-
- Moderate/Advanced items must be manually checked in the Disk Cleanup tab
183-
- Locked files are silently skipped — no errors, no data loss
184-
- System processes cannot be killed from the Memory tab
185-
186-
> Full safety details: [`docs/SAFETY.md`](docs/SAFETY.md)
210+
<br>
187211

188212
## Contributing
189213

@@ -195,6 +219,12 @@ cd system-cleaner && npm install
195219
npm run tauri:dev
196220
```
197221

222+
<br>
223+
224+
<div align="center">
225+
198226
## License
199227

200-
[MIT](LICENSE)
228+
[MIT](LICENSE) · Built by [TMHSDigital](https://github.com/TMHSDigital)
229+
230+
</div>

0 commit comments

Comments
 (0)