initial hack sesh

1 files changed, 56 insertions, 0 deletions

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"
+        }
+      ]
+    }
+  }
+}
+```