Skip to content

Commit 5cf19e3

Browse files
committed
Docs and schemas
1 parent 9a302ba commit 5cf19e3

File tree

6 files changed

+18
-1
lines changed

6 files changed

+18
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
### websockets-notifications Demo
1+
## websockets-notifications Demo
2+
3+
A notification service via WebSockets.
4+
Allows clients to connect, authenticate through a JWT token, and subscribe to events.
5+
Events are captured by a consumer and all subscribers are notified.
6+
7+
[Documentation schemas](./docs/)
28

39
This project requires Python 3.12+.
410
Dependencies are managed by [uv](https://github.com/astral-sh/uv) and should be installed.

docs/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
### Service scheme
2+
<img src="./misc/main_scheme.png" alt="Main Scheme" height="300">
3+
4+
### Subscribe and unsubscribe scheme
5+
<img src="./misc/subscribe_unsubscribe_scheme.png" alt="subscribe_unsubscribe_scheme" height="400">
6+
7+
### Consumer scheme
8+
<img src="./misc/consumer_scheme.png" alt="subscribe_unsubscribe_scheme" height="300">
9+
10+
### Storage scheme
11+
<img src="./misc/storage.png" alt="subscribe_unsubscribe_scheme" height="400">

docs/misc/consumer_scheme.png

74.2 KB
Loading

docs/misc/main_scheme.png

87.2 KB
Loading

docs/misc/storage.png

136 KB
Loading
191 KB
Loading

0 commit comments

Comments
 (0)