From 56320bede0be11219a9e36f01facd0916d3659b6 Mon Sep 17 00:00:00 2001
From: Michael <michael.lindman@gmail.com>
Date: Fri, 12 Apr 2019 07:06:05 +0100
Subject: [PATCH] new readme file

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..81f2825
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# brightness
+
+Simple python script to change display brightness on active display using xrandr and xdotool.
+
+## Setup Instructions
+
+### Requirements
+
+* python3
+* xrandr
+* xdotool
+
+### Setup
+
+```sh
+git clone git@0cd.xyz:michael/brightness.git
+```
+
+create settings file with your display IDs
+
+```json
+{
+    "display0" : "DP-2",
+    "display1" : "DP-1"
+}
+```
+
+run script with
+
+```sh
+Usage: ./brightness.py [+|-]
+brightness + # increases brightness
+brightness - # decreases brightness
+```
\ No newline at end of file