From f4ff07a8b4519251a2289efff4f458ea0bcf5934 Mon Sep 17 00:00:00 2001
From: 2 * r + 2 * t <61896496+soramanew@users.noreply.github.com>
Date: Sat, 7 Jun 2025 23:17:30 +1000
Subject: feat: create readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e28f64c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# caelestia-shell
+
+https://github.com/user-attachments/assets/0840f496-575c-4ca6-83a8-87bb01a85c5f
+
+## Components
+
+- Widgets: [`Quickshell`](https://quickshell.outfoxxed.me/)
+- Window manager: [`Hyprland`](https://hyprland.org/)
+- Dots: [`caelestia`](https://github.com/caelestia-dots/)
+
+## Installation
+
+### Automated installation (recommended)
+
+Install [`caelestia-scripts`](https://github.com/caelestia-dots/scripts/) and run `caelestia install shell`.
+
+### Manual installation
+
+Clone this repo into `$XDG_CONFIG_HOME/quickshell/caelestia` and run `qs -c caelestia`.
+
+## Credits
+
+Thanks to the Hyprland discord community (especially the homies in #rice-discussion) for all the help and suggestions
+for improving these dots!
+
+A special thanks to [@outfoxxed](https://github.com/outfoxxed/) for making Quickshell and the effort put into fixing issues
+and implementing various feature requests.
-- 
cgit v1.2.3-freya