From 7cd8becb29c96a06f0c1b0cfb623ed5e98911613 Mon Sep 17 00:00:00 2001
From: Ethel Morgan <eth@ethulhu.co.uk>
Date: Tue, 7 Jul 2020 18:37:42 +0100
Subject: initial hack sesh

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

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..79cddfb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+<!--
+SPDX-FileCopyrightText: 2020 Ethel Morgan
+
+SPDX-License-Identifier: CC0-1.0
+-->
+
+# Dispatch Server
+
+## Config
+
+For example,
+
+```json
+{
+  "actions": {
+    "update Catbus UI": {
+      "triggers": [
+        {
+          "url": "/gitolite-repo-updated",
+          "formValues": {
+            "repo": "catbus-web-ui"
+          }
+        }
+      ],
+      "outputs": [
+        {
+          "url": "https://build.eth.moe/deploy",
+          "formValues": {
+            "project": "catbus-web-ui"
+          }
+        }
+      ]
+    },
+    "turn lights on": {
+      "triggers": [
+        {
+          "url": "/living-room/lights-on",
+          "formValues": {
+            "power": "on"
+          }
+        }
+      ],
+      "outputs": [
+        {
+          "mqtt": "tcp://catbus.eth.moe/home/living-room/sofa-light/power",
+          "value": "on"
+        },
+        {
+          "mqtt": "tcp://catbus.eth.moe/home/living-room/front-light/power",
+          "value": "on"
+        }
+      ]
+    }
+  }
+}
+```
-- 
cgit v1.2.3