Skip to content

Revise README for clarity and detail #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
damachine merged 1 commit into from
Sep 8, 2025
Merged

Revise README for clarity and detail #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# CoolerDash - Extends [CoolerControl](https://gitlab.com/coolercontrol/coolercontrol) with a polished LCD-Dashboard
# CoolerDash - Make your LCD shine the way it was meant to.

[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
[![Platform](https://img.shields.io/badge/Platform-Linux-green.svg)](https://kernel.org/)
Expand All @@ -14,9 +14,9 @@

## 📖 Description

**CoolerDash is an add-on for CoolerControl that enhances your water cooling display with additional features and a polished LCD dashboard. It builds on CoolerControl's solid foundation to provide a more customizable and informative display experience.**
**CoolerDash is an add-on wrapper for [CoolerControl](https://gitlab.com/coolercontrol/coolercontrol) that enhances your water-cooling display with extra features and a polished, customizable LCD dashboard.**

Special thanks to @codifryed, the developer of CoolerControl!
> ##### Special thanks to @codifryed, the founder of CoolerControl

### 📸 Screenshot – Example LCD Output

Expand Down Expand Up @@ -66,7 +66,7 @@ Special thanks to @codifryed, the developer of CoolerControl!
# STEP 1: Install
yay -S coolerdash-git

# STEP 2: Enable ans start CoolerDash (after install or update)
# STEP 2: Enable and start CoolerDash (after install or update)
systemctl daemon-reload
systemctl enable --now coolerdash.service
```
Expand Down Expand Up @@ -262,6 +262,10 @@ MIT License - See LICENSE file for details.

[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)

Individual Coolercontrol package have their own licenses:

See respective repositories at [https://gitlab.com/coolercontrol/coolercontrol](https://gitlab.com/coolercontrol/coolercontrol)

---

## 💝 Support the Project
Expand Down
Loading