Add server/README.md

iamgio · Dec 1, 2024 · 9a8457b · 9a8457b
1 parent a4440ea
commit 9a8457b
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/server/README.md b/server/README.md
@@ -0,0 +1,12 @@
+# server
+
+This module contains code for Quarkdown's local webserver,
+which enables automatic browser reload according to this flow:
+
+1. The server starts;
+2. When the address is opened in the browser,
+the injected [`websockets.js`](../core/src/main/resources/render/script/websockets.js) script
+begins listening to `/reload` for messages.
+3. The [CLI](../cli), upon generating output files, sends a message via websockets to `/reload`;
+4. The server forwards this message to the listening clients (browsers);
+5. Each client reloads its content as soon as it receives the message.