Skip to content

Commit cdc72e4

Browse files
authored
Update README.md
1 parent 36ae626 commit cdc72e4

File tree

1 file changed

+90
-2
lines changed

1 file changed

+90
-2
lines changed

README.md

Lines changed: 90 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,90 @@
1-
# ChroMate
2-
Your daily dose of Chromium freshness – automatic updates, dark mode, and sync options bundled into one sleek GUI.
1+
# 🌐 ChroMate
2+
3+
> Your daily dose of Chromium freshness – automatic updates, dark mode, and sync options bundled into one sleek GUI.
4+
5+
---
6+
7+
**ChroMate** is a modern, sleek, and powerful updater for Chromium on Windows. Built with a dark-themed interface using `customtkinter`, it makes staying updated as effortless as clicking a button.
8+
9+
---
10+
11+
## ✨ Features
12+
13+
-**Sync / No-Sync Build Selection**
14+
- 🌙 **Dark Mode UI** (customtkinter powered)
15+
- 🔄 **Automatic Update Check with Scheduler Support**
16+
- 📦 **SHA256 File Integrity Validation**
17+
- 📥 **Progress Bar with ETA** for downloads
18+
- 🔔 **Native Desktop Notifications** (via `plyer`)
19+
- 📜 **Integrated Log Viewer** + Clear Logs Button
20+
- ⚙️ **Windows Task Scheduler Integration**
21+
- 🧠 **Smart Chromium Detection** (auto finds installation path)
22+
23+
---
24+
25+
## 📸 Screenshots
26+
27+
<p align="center">
28+
<img src="https://github.com/user-attachments/assets/edc743c9-9123-4a45-89e5-4372791f5786" width="700"/>
29+
</p>
30+
31+
---
32+
33+
## 🛠 Installation
34+
35+
```bash
36+
pip install customtkinter requests pefile plyer
37+
```
38+
39+
> ⚠️ Requires **Python 3.9+** on Windows
40+
41+
---
42+
43+
## 🚀 Usage
44+
45+
### Option 1: Run from source
46+
```bash
47+
python main_gui.py
48+
```
49+
50+
### Option 2: Download the prebuilt executable
51+
➡️ Visit the [Releases](https://github.com/fatih-gh/ChroMate/releases) section to download the latest `.exe` build — no Python needed!
52+
53+
### Option 3: Build manually using PyInstaller
54+
```bash
55+
pyinstaller --noconfirm --onefile --windowed \
56+
--icon=chromium_updater_icon.ico \
57+
--add-data "chromium_updater_icon.ico;." \
58+
main_gui.py
59+
```
60+
61+
---
62+
63+
## 🔍 Sync vs No-Sync?
64+
65+
- **Sync** = Standard Chromium build with Google Sign-in and sync functionality.
66+
- **No-Sync** = Ungoogled Chromium – privacy-enhanced, stripped from Google services.
67+
68+
You're free to choose the flavor that fits your needs 😎
69+
70+
---
71+
72+
## 🧠 Developer Note
73+
74+
This project uses [Hibbiki](https://github.com/Hibbiki/chromium-win64)'s Chromium builds. Make sure to star their repo too!
75+
76+
---
77+
78+
## 📄 License
79+
80+
GPLv3 License © 2025 Fatih
81+
82+
This project is licensed under the terms of the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for details.
83+
84+
---
85+
86+
## 👤 Author
87+
88+
**Developed by [Fatih](https://github.com/fatih-gh)**
89+
Say hi or report an issue — contributions and ideas are welcome!
90+

0 commit comments

Comments
 (0)