From eea2be1d584ab8908eb7905fe36036a6bd3744ca Mon Sep 17 00:00:00 2001
From: Semih Kaiser <git@oryfox.de>
Date: Tue, 29 Sep 2026 01:14:22 +0200
Subject: [PATCH] Add Readme

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6968896
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# dualsense-qs
+
+This project utilizes [quickshell](https://quickshell.org/) and [dualsensectl](https://github.com/nowrep/dualsensectl) to display a small widget indicating battery and charging status on connection. Both are required to run this widget.
+
+Example Installation with AUR helper: \
+`yay -S quickshell dualsensectl-git`
+
+Clone the repository to your quickshell config directory, for example: \
+`git clone https://git.oryfox.de/public/dualsense-qs.git ~/.config/quickshell/dualsense-qs`
+
+Add the quickshell command to your startup: \
+`qs -c dualsense-qs`
\ No newline at end of file