From 28fbf1ba8bd2ac3be45fc9b8d099fd0380475375 Mon Sep 17 00:00:00 2001
From: Alessandro Mauri <alemauri001@gmail.com>
Date: Sun, 6 Oct 2024 12:58:45 +0200
Subject: [PATCH] add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d6d86ea
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# Ambient Light Daemon
+
+Automatically adjusts backlight brightness on the current light level.
+Uses the luminance sensor of a laptop to determine a target brightness, the user
+can further adjust the brightness between updates to give the program an offset
+to respect.
+
+## Install
+
+Copy ambient.py to a directory in PATH: `sudo cp ambient.py /usr/local/bin`
+
+## User Service
+
+Currently only a runit service is implemented, to install copy the `./sv/ambientd`
+directory to the global or user runsvdir and start the service