From e8070be201b3fca1550abb3a2084ecaf84722608 Mon Sep 17 00:00:00 2001
From: Aminda Suomalainen <suomalainen+git@mikaela.info>
Date: Sat, 25 Mar 2023 18:19:50 +0200
Subject: [PATCH] matrix/uk.half-shot.matrix-hookshot.feed/README.md: check how
 hookshot configures state

---
 .../README.md                                 | 46 +++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 matrix/uk.half-shot.matrix-hookshot.feed/README.md

diff --git a/matrix/uk.half-shot.matrix-hookshot.feed/README.md b/matrix/uk.half-shot.matrix-hookshot.feed/README.md
new file mode 100644
index 0000000..80cc52c
--- /dev/null
+++ b/matrix/uk.half-shot.matrix-hookshot.feed/README.md
@@ -0,0 +1,46 @@
+# hookshot room state configuration
+
+When Hookshot is configured via the manage integrations menu, it appears to
+perform two state installations/directories/whatever:
+
+- `uk.half-shot.matrix-hookshot.feed`
+  - contains state events with the feed name
+    - contains the json below
+- `io.element.integrations.installations`
+  - contains uuid below
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [feed](#feed)
+- [installation](#installation)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+--
+
+## feed
+
+This entry is the feed url e.g.
+`https://feeds.yle.fi/uutiset/v1/recent.rss?publisherIds=YLE_NEWS`, and
+contains:
+
+```json
+{
+  "label": "YLE News in English",
+  "url": "https://feeds.yle.fi/uutiset/v1/recent.rss?publisherIds=YLE_NEWS"
+}
+```
+
+## installation
+
+This probably has or should be left for the integration manager.
+
+```json
+{
+  "appId": "hookshot-feeds",
+  "installationId": "uuid-goes-here",
+  "userIds": ["@feeds:integrations.ems.host"],
+  "widgetIds": []
+}
+```