Docs and schemas (#23)

fandsdev · Jun 14, 2024 · 0e911d9 · 0e911d9
1 parent 9a302ba
commit 0e911d9
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,4 +1,10 @@
-### websockets-notifications Demo
+## websockets-notifications Demo
+
+A notification service via WebSockets. 
+Allows clients to connect, authenticate through a JWT token, and subscribe to events.
+Events are captured by a consumer and all subscribers are notified.
+
+[Documentation schemas](./docs/)
 
 This project requires Python 3.12+.
 Dependencies are managed by [uv](https://github.com/astral-sh/uv) and should be installed.

diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,11 @@
+### Service scheme
+<img src="./misc/main_scheme.png" alt="Main Scheme" height="300">
+
+### Subscribe and unsubscribe scheme
+<img src="./misc/subscribe_unsubscribe_scheme.png" alt="subscribe_unsubscribe_scheme" height="400">
+
+### Consumer scheme
+<img src="./misc/consumer_scheme.png" alt="subscribe_unsubscribe_scheme" height="300">
+
+### Storage scheme
+<img src="./misc/storage.png" alt="subscribe_unsubscribe_scheme" height="400">
diff --git a/docs/misc/consumer_scheme.png b/docs/misc/consumer_scheme.png
diff --git a/docs/misc/main_scheme.png b/docs/misc/main_scheme.png
diff --git a/docs/misc/storage.png b/docs/misc/storage.png
diff --git a/docs/misc/subscribe_unsubscribe_scheme.png b/docs/misc/subscribe_unsubscribe_scheme.png