From c5390d8ca59a3e0a2ea40e15f86bd7d1ce2ef62a Mon Sep 17 00:00:00 2001
From: steel99xl <steel99xl@gmail.com>
Date: Mon, 31 Oct 2022 18:46:37 -0400
Subject: [PATCH] Config Explianed

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index 08e0304..ef24bc2 100644
--- a/README.md
+++ b/README.md
@@ -5,3 +5,16 @@ made for the FrameWork laptop
 
 ## Requires 
 brightnessctl
+
+## Configuring
+```LevelSteps```  Sets amount of brightness stesp, recomended to match refeshrate
+
+```AnimationDelay```  Speed of the brightness animation, recomended screen refreshrate in seconds
+
+```MaxScreenBrightness``` The highest value your screen supports, check your /sys/class/backlight/{GPU_MAIN_SCREEN}/brightness
+
+```SensorDelay``` Time in seconds the script will wait to check the sensor for a luminess change
+
+```MinimunBrightness``` The minimum screen brightness, recomended minumim 001 so the backlight dosn't turn off
+
+```SensorToDisplayScale``` The ratio from sensor to screen brighness, recommended minimum 24 for 12th gen framework laptops. The script will limit the max values to MaxScreenBrighness