From 8f0481d3198179e1c41047b1d85f5a7d76b77816 Mon Sep 17 00:00:00 2001
From: Allusive <99632976+allusive-dev@users.noreply.github.com>
Date: Sat, 2 Dec 2023 08:40:14 +1100
Subject: Update compfy.md

---
 man/compfy.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

(limited to 'man')

diff --git a/man/compfy.md b/man/compfy.md
index 15f5169..f86a11b 100644
--- a/man/compfy.md
+++ b/man/compfy.md
@@ -4,6 +4,37 @@
 
 #### Config can be placed at either `~/.config/compfy.conf` or `~/.config/compfy/compfy.conf`
 
+## Basic Syntax
+
+Variables are formatted like this
+
+```
+variable-name = value;
+```
+All values require a semi-colon on the end as shown above.
+
+When declaring a animation-name you need to use double quotes like such
+
+```
+animation-for-unmap-window = "slide-down";
+```
+
+When using rule-sets there are two ways to provide windows to it.
+
+With almost every rule-set it will follow this syntax and structure.
+
+```
+rule-set = [
+  "class_g = 'foo'" # Select windows by classname
+  "name = 'bar'" # Select windows by name
+];
+```
+
+In the example you replace `foo` with the `WM_CLASS` which can be found using the `xprop` command provided by [xorg-xprop](https://archlinux.org/packages/extra/x86_64/xorg-xprop/) on Arch and `xorg.xprop` on NixOS.
+
+Sometimes `xprop` will output multiple class names. If the first class name does not work, try the second one.
+
+
 # Options
 
 ## corner-radius
-- 
cgit v1.2.3