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