From 76f4f3f024381216368dff52a7b6e3e7b0aaad65 Mon Sep 17 00:00:00 2001
From: Franziska Kunsmann <hi@kunsmann.eu>
Date: Tue, 8 Aug 2023 06:34:26 +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..605ee08
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# Viri Alerts to DMX lights (via sACN)
+
+This software will convert incoming alerts from the #voc-wok irc channel
+into sACN messages, so the alerts can be shown on some dmx lights.
+
+We currently support the following lighting fixtures:
+
+- [Ignition WAL-L710 Par](https://www.thomann.de/gb/ignition_wal_l710_par_w_dmx.htm)
+  (only W-DMX version was tested)
+- [Varytec Hero Wash 712 Z RGBW Zoom](https://www.thomann.de/gb/varytec_hero_wash_712_z_rgbw_zoom.htm)
+  (pan/tilt fixed to center)
+- [WLED "multi RGB"](https://kno.wled.ge/interfaces/e1.31-dmx/)
+
+For all options, please have a look at our [example config file](config.example.toml)
+which lists all available configuration values including some explaination.