From 96db172d8ef1c98cab75ab0eb8e2808349e6aeb0 Mon Sep 17 00:00:00 2001
From: ni-richard <ni-richard@protonmail.ch>
Date: Fri, 13 Sep 2019 23:49:49 +0200
Subject: [PATCH] Created frontend.ready (markdown)

---
 frontend.ready.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 frontend.ready.md

diff --git a/frontend.ready.md b/frontend.ready.md
new file mode 100644
index 0000000..63bfee7
--- /dev/null
+++ b/frontend.ready.md
@@ -0,0 +1,30 @@
+### Request
+* **Description**: The frontend signals that it has loaded everything and is waiting for the config keys.
+* **Subscribers**: [FrontendConfigHandler](https://github.com/avatao-content/baseimage-tutorial-framework/wiki/FrontendConfigHandler)
+
+```json
+{
+    "key": "frontend.ready",
+    "intent": "control",
+    "scope": "zmq"
+}
+```
+
+***
+
+**Example**: Same as above, does not have additional parameters.
+
+### Response
+* **Description**: After sending out every config key, the backend answers with the same message to indicate that the user may interact with the site now.
+* **Subscribers**: *(none)*
+
+```json
+{
+    "key": "frontend.ready",
+    "scope": "websocket"
+}
+```
+
+***
+
+**Example**: Same as above, does not have additional parameters.
\ No newline at end of file