1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8c9174d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# omega2-ws2811-lkm
+Linux kernel module for Onion Omega2 to control WS2811/WS2812 LEDs
+
+It's using bit banging, so you can use any GPIO pin. Also it supports multiple pins simultaneously and writing it at the same time, so you can connect multiple LED chains to different pins and increase FPS.
+
+## How to load
+Put **ws2811** into /lib/modules/*kernel_version*/ directory
+
+There are two parameters:
+* **pins** - array of pin numbers
+* **led_count** - LED count per pin
+
+For example you are using pins 11,15,16,17 and 300 LEDs per each pin, command to load module:
+
+    insmod ws2811 pins=11,15,16,17 led_count=300
+
+or create /etc/modules.d/ws2811 file and put this string there:
+
+    ws2811 pins=11,15,16,17 led_count=300
+
+to load module automatically at system boot.
+
+## How to use
+If module is loaded successfully **/dev/ws2811** pseudo-file should appear. You can read and write it - three bytes per each RGB LED.
+Syncronization appears after each write operation, so it is desirable to write all bytes at once.