From 9369b535347f0635b7010c7f653cea93b379f126 Mon Sep 17 00:00:00 2001
From: Smasty <martin@smasty.net>
Date: Thu, 1 Feb 2018 22:13:01 +0100
Subject: [PATCH] Add Readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..97bbe46
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# Logitech G203 Prodigy LED Control
+
+Allows you to control the LED lighting of your G203 programmatically.
+Inspired by and based on [g810-led](https://github.com/MatMoul/g810-led)
+
+## Requirements
+
+- Python 3.5+
+- PyUSB 1.0.2+
+- *Root privileges*
+
+## Installation
+
+1) Clone the repository: `git clone https://github.com/smasty/g203-led.git`
+2) Install dependencies: `pip install -r requirements.txt`
+3) Run (as root): `sudo ./g203-led.py solid 00FFFF`
+
+## Usage
+
+```
+Usage:
+    g203-led solid {color} - Solid color mode
+    g203-led cycle [{rate} [{brightness}]] - Cycle through all colors
+    g203-led breathe {color} [{rate} [{brightness}]] - Single color breathing
+
+Arguments:
+    Color: RRGGBB (RGB hex value)
+    Rate: 100-60000 (Number of milliseconds. Default: 10000ms)
+    Brightness: 0-100 (Percentage. Default: 100%)""")
+```