Skip to content

Commit eb7d54d

Browse files
committed
Refine README.md by updating project description, adjusting icon size, and enhancing formatting. Streamline feature presentation and clarify installation instructions. Improve safety model section for better user understanding.
1 parent 78bf94a commit eb7d54d

1 file changed

Lines changed: 115 additions & 151 deletions

File tree

README.md

Lines changed: 115 additions & 151 deletions
Original file line numberDiff line numberDiff line change
@@ -1,230 +1,194 @@
11
<div align="center">
22

3-
<br>
4-
5-
<img src="src-tauri/icons/icon.png" width="100" alt="System Health Tool icon">
3+
<img src="src-tauri/icons/icon.png" width="80" alt="System Health Tool">
64

75
<br>
86

97
# System Health Tool
108

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)
9+
A lightweight, open-source Windows desktop app that scans, diagnoses,<br>and cleans up system issues — built for people who aren't technical.
1810

1911
<br>
2012

21-
`~2.5 MB installer` &nbsp;·&nbsp; `No bloat` &nbsp;·&nbsp; `No telemetry` &nbsp;·&nbsp; `Open source`
13+
[![License](https://img.shields.io/badge/license-MIT-222?style=for-the-badge)](LICENSE)
14+
&nbsp;
15+
[![Tauri](https://img.shields.io/badge/Tauri_2-24C8D8?style=for-the-badge&logo=tauri&logoColor=white)](https://v2.tauri.app)
16+
&nbsp;
17+
[![React](https://img.shields.io/badge/React_19-61DAFB?style=for-the-badge&logo=react&logoColor=000)](https://react.dev)
18+
&nbsp;
19+
[![Rust](https://img.shields.io/badge/Rust-DEA584?style=for-the-badge&logo=rust&logoColor=000)](https://www.rust-lang.org)
2220

2321
<br>
2422

25-
<!-- TODO: Replace with actual screenshot once published -->
26-
<!-- <img src="docs/assets/screenshot.png" width="720" alt="App screenshot"> -->
27-
28-
---
29-
30-
</div>
23+
`~2.5 MB` &nbsp;&bull;&nbsp; `No bloat` &nbsp;&bull;&nbsp; `No telemetry` &nbsp;&bull;&nbsp; `Open source`
3124

3225
<br>
3326

34-
## Overview
27+
[Download](https://github.com/TMHSDigital/system-cleaner/releases) &nbsp;&nbsp;|&nbsp;&nbsp; [Build from source](#build-from-source) &nbsp;&nbsp;|&nbsp;&nbsp; [Contributing](docs/CONTRIBUTING.md)
3528

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.
29+
</div>
3730

3831
<br>
3932

40-
## Features
33+
---
4134

42-
<table>
43-
<tr>
44-
<td width="50%" valign="top">
35+
<br>
4536

46-
#### &nbsp;&nbsp;📊&nbsp;&nbsp;Dashboard
47-
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.
37+
### What it does
4838

49-
</td>
50-
<td width="50%" valign="top">
39+
One window. Five panels. Everything your PC needs to stay healthy.
5140

52-
#### &nbsp;&nbsp;🧹&nbsp;&nbsp;Disk Cleanup
53-
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.
41+
| Panel | What you get |
42+
|:------|:-------------|
43+
| **Dashboard** | Real-time health score (0-100), drive space bars, RAM donut chart, one-click **Quick Clean** that only touches safe items |
44+
| **Disk Cleanup** | Scans temp files, browser caches, crash dumps, dev caches, recycle bin — every item tagged with a color-coded risk level |
45+
| **Memory** | Live RAM usage, runaway process detection, Hyper-V and WSL VM detection, direct process kill for non-system processes |
46+
| **Startup** | Toggle startup programs on/off with impact ratings and "recommended to disable" flags — nothing is uninstalled, just toggled |
47+
| **Recommendations** | Auto-generated tips like *"Your pagefile is on a full drive"* with a **Fix It** button that jumps to the right panel |
5448

55-
</td>
56-
</tr>
57-
<tr>
58-
<td width="50%" valign="top">
49+
<br>
5950

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

63-
</td>
64-
<td width="50%" valign="top">
53+
> [!IMPORTANT]
54+
> Nothing is deleted without showing you exactly what will happen first.
6555
66-
#### &nbsp;&nbsp;&nbsp;&nbsp;Startup Manager
67-
Toggle startup programs on/off with impact ratings (High / Medium / Low) and "recommended to disable" badges. Nothing is uninstalled — just toggled.
56+
| Risk | What it means |
57+
|:-----|:--------------|
58+
| **Safe** | Always fine to delete. Temp files, caches, crash dumps — regenerated automatically. Quick Clean only touches these. |
59+
| **Moderate** | Dev caches, Windows Update files. Re-downloaded on demand. Must be manually selected. |
60+
| **Advanced** | Reserved for future features. Will require explicit confirmation. |
6861

69-
</td>
70-
</tr>
71-
<tr>
72-
<td colspan="2" valign="top">
62+
Locked files are silently skipped. System processes cannot be killed. Full details in [`docs/SAFETY.md`](docs/SAFETY.md).
7363

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.
64+
<br>
7665

77-
</td>
78-
</tr>
79-
</table>
66+
---
8067

8168
<br>
8269

83-
## Quick Start
70+
### Install
8471

85-
### Download
72+
Grab the latest build from [**Releases**](https://github.com/TMHSDigital/system-cleaner/releases):
8673

87-
Grab the latest installer from [**Releases**](https://github.com/TMHSDigital/system-cleaner/releases):
88-
89-
| Format | Size | Notes |
90-
|--------|------|-------|
91-
| `System Cleaner_x.x.x_x64-setup.exe` | ~2.5 MB | NSIS installer (recommended) |
92-
| `System Cleaner_x.x.x_x64_en-US.msi` | ~3.8 MB | MSI installer |
74+
| Installer | Size |
75+
|:----------|:-----|
76+
| `System Cleaner_x.x.x_x64-setup.exe` (NSIS) | ~2.5 MB |
77+
| `System Cleaner_x.x.x_x64_en-US.msi` | ~3.8 MB |
9378

9479
> [!NOTE]
95-
> The app requests admin privileges on launch — needed for clearing Windows temp files, managing services, and reading all processes.
80+
> Admin privileges are requested on launch — required for clearing system temp files, managing services, and reading all processes.
81+
82+
<br>
9683

9784
### Build from source
9885

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/)
86+
Requires [Node.js](https://nodejs.org/) 18+, [Rust](https://rustup.rs/) 1.85+, and Windows 10/11 with [WebView2](https://developer.microsoft.com/en-us/microsoft-edge/webview2/).
10087

10188
```bash
10289
git clone https://github.com/TMHSDigital/system-cleaner.git
103-
cd system-cleaner
104-
npm install
90+
cd system-cleaner && npm install
10591

106-
npm run tauri:dev # dev mode with hot reload
107-
npm run tauri:build # production build → src-tauri/target/release/bundle/
92+
npm run tauri:dev # dev mode hot reload
93+
npm run tauri:build # production → src-tauri/target/release/bundle/
10894
```
10995

11096
<br>
11197

112-
## Tech Stack
113-
114-
| Layer | Technology |
115-
|-------|-----------|
116-
| **Frontend** | React 19 · TypeScript 5.9 · Tailwind CSS v4 · Recharts |
117-
| **Backend** | Tauri 2 (Rust) — native Win32 & registry access via `tauri::command` |
118-
| **Bundler** | Vite 7 |
119-
| **Icons** | Lucide React |
98+
---
12099

121100
<br>
122101

123-
## Architecture
102+
### Architecture
124103

125104
```
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
105+
┌─────────────────────────────────────┐
106+
│ Tauri Window │
107+
│ │
108+
│ React 19 + TypeScript + Tailwind │
109+
│ Dashboard / Disk / Memory / │
110+
│ Startup / Recommendations │
111+
│ ↕ api.ts │
112+
│ ──────────────────────────────────── │
113+
│ Rust Backend (Tauri 2) │
114+
│ disk · memory · startup · cleanup │
115+
│ · recommendations │
116+
└────┬──────────┬──────────────┬───────┘
117+
│ │ │
118+
Win32 API PowerShell Registry
143119
```
144120

145-
> Full architecture docs: [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md)
121+
Full architecture docs: [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md)
146122

147123
<br>
148124

149-
## Safety
150-
151-
> [!IMPORTANT]
152-
> No files are ever deleted without showing you exactly what will happen first.
125+
### Tech stack
153126

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 |
127+
| | |
128+
|:--|:--|
129+
| **Frontend** | React 19 &middot; TypeScript 5.9 &middot; Tailwind CSS v4 &middot; Recharts |
130+
| **Backend** | Tauri 2 (Rust) &middot; Win32 API &middot; PowerShell &middot; Registry |
131+
| **Build** | Vite 7 &middot; Cargo |
132+
| **Icons** | Lucide React |
161133

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
134+
<br>
166135

167-
> Full safety details: [`docs/SAFETY.md`](docs/SAFETY.md)
136+
<details>
137+
<summary><strong>Project structure</strong></summary>
168138

169139
<br>
170140

171-
## Project Structure
172-
173141
```
174-
system-cleaner/
175-
├── src/ # React frontend
176-
│ ├── App.tsx # Sidebar nav + tab routing
177-
│ ├── components/
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
190-
│ ├── src/
191-
│ │ ├── lib.rs # Tauri bootstrap + command registration
192-
│ │ ├── main.rs # Windows entry point
193-
│ │ └── commands/
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
199-
│ ├── tauri.conf.json
200-
│ └── Cargo.toml
201-
├── docs/
202-
│ ├── ARCHITECTURE.md
203-
│ ├── SAFETY.md
204-
│ └── CONTRIBUTING.md
205-
├── package.json
206-
├── vite.config.ts
207-
└── tsconfig.json
142+
src/
143+
├── App.tsx # Sidebar nav + tab routing
144+
├── components/
145+
│ ├── Dashboard.tsx # Health score, drives, RAM, Quick Clean
146+
│ ├── DiskCleanup.tsx # Scan → Review → Clean workflow
147+
│ ├── MemoryPanel.tsx # RAM chart, processes, VM detection
148+
│ ├── StartupManager.tsx # Toggle switches + impact ratings
149+
│ └── Recommendations.tsx # Auto-tips with Fix It navigation
150+
├── lib/
151+
│ ├── api.ts # Typed Tauri invoke() wrappers
152+
│ ├── types.ts # Shared interfaces
153+
│ └── format.ts # Byte/percent formatting
154+
└── styles/
155+
└── tokens.css # Design tokens + component classes
156+
157+
src-tauri/
158+
├── src/
159+
│ ├── lib.rs # Tauri bootstrap + command registration
160+
│ ├── main.rs # Windows entry point
161+
│ └── commands/
162+
│ ├── disk.rs # Drive info, temp/cache scanning
163+
│ ├── memory.rs # RAM stats, process list, VM detection
164+
│ ├── startup.rs # Registry + folder startup management
165+
│ ├── cleanup.rs # Safe deletion with progress tracking
166+
│ └── recommendations.rs # Auto-generated system tips
167+
├── tauri.conf.json
168+
└── Cargo.toml
169+
170+
docs/
171+
├── ARCHITECTURE.md
172+
├── SAFETY.md
173+
└── CONTRIBUTING.md
208174
```
209175

176+
</details>
177+
210178
<br>
211179

212-
## Contributing
180+
---
213181

214-
PRs welcome. See [`docs/CONTRIBUTING.md`](docs/CONTRIBUTING.md) for setup instructions, code style, and how to add new cleanup targets or recommendations.
182+
<br>
215183

216-
```bash
217-
git clone https://github.com/TMHSDigital/system-cleaner.git
218-
cd system-cleaner && npm install
219-
npm run tauri:dev
220-
```
184+
### Contributing
185+
186+
PRs welcome. See [`docs/CONTRIBUTING.md`](docs/CONTRIBUTING.md) for setup, code style, and how to add new cleanup targets.
221187

222188
<br>
223189

224190
<div align="center">
225191

226-
## License
227-
228-
[MIT](LICENSE) · Built by [TMHSDigital](https://github.com/TMHSDigital)
192+
[MIT License](LICENSE) &middot; [TMHSDigital](https://github.com/TMHSDigital)
229193

230194
</div>

0 commit comments

Comments
 (0)