From 203b87e7eb541086785729b709f7f69399c1efdf Mon Sep 17 00:00:00 2001
From: Candifloss <candifloss@candifloss.cc>
Date: Sun, 8 Dec 2024 11:06:36 +0000
Subject: [PATCH] Update README.md

---
 README.md | 28 ++++++++++++++++++++++++++--
 1 file changed, 26 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index a9d1c5a..7592f45 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,27 @@
-# leftWM-Config
+# LeftWM Config files  
 
-LeftWM Config
\ No newline at end of file
+Config for [LeftWM](https://github.com/leftwm/leftwm), a window manager written in rust.  
+Config location: `~/.config/leftwm/config.ron`  
+
+## Theme config  
+
+The scripts and config files for the theme must be in a directory sym-linked to `~/.config/leftwm/themes/current/`.  
+Minimum required files:  
+- `theme.ron`: LeftWM theme config including border color, margins, etc.  
+- `up`: This script is called on login. The `theme.ron` must be loaded by this script using LeftWM's `LoadTheme` command:  
+```bash
+leftwm command "LoadTheme ~/.config/leftwm/themes/current/theme.ron"
+```  
+  Add lines to load other theme elements like `eww daemon`, `polybar`, or anything you have configured for your desktop.  
+- `down`: To unload the theme.  
+
+```
+~/.config/
+└── leftwm/
+    ├── config.ron
+    └── themes/
+        └── current/
+            ├── theme.ron
+            ├── up
+            └── down
+```
\ No newline at end of file