diff --git a/README.md b/README.md index 845fd77..52b2fe6 100644 --- 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 new file mode 100644 index 0000000..b9a8650 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,11 @@ +### Service scheme +Main Scheme + +### Subscribe and unsubscribe scheme +subscribe_unsubscribe_scheme + +### Consumer scheme +subscribe_unsubscribe_scheme + +### Storage scheme +subscribe_unsubscribe_scheme \ No newline at end of file diff --git a/docs/misc/consumer_scheme.png b/docs/misc/consumer_scheme.png new file mode 100644 index 0000000..998f6f0 Binary files /dev/null and b/docs/misc/consumer_scheme.png differ diff --git a/docs/misc/main_scheme.png b/docs/misc/main_scheme.png new file mode 100644 index 0000000..7721e2a Binary files /dev/null and b/docs/misc/main_scheme.png differ diff --git a/docs/misc/storage.png b/docs/misc/storage.png new file mode 100644 index 0000000..6391d30 Binary files /dev/null and b/docs/misc/storage.png differ diff --git a/docs/misc/subscribe_unsubscribe_scheme.png b/docs/misc/subscribe_unsubscribe_scheme.png new file mode 100644 index 0000000..cce9f22 Binary files /dev/null and b/docs/misc/subscribe_unsubscribe_scheme.png differ