first commit
This commit is contained in:
27
README.md
Normal file
27
README.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# StatusServer
|
||||
|
||||
A lightweight **pub/sub server** built on WebSockets.
|
||||
It is designed to broadcast **status updates** and **error messages** to connected clients in real-time.
|
||||
No database, no persistence — just simple and fast messaging.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Features
|
||||
- **Real-time updates** over WebSockets
|
||||
- **Pub/Sub model**: subscribe to topics and receive broadcasts
|
||||
- **Zero persistence**: messages are ephemeral and only delivered to connected clients
|
||||
- **Lightweight**: no external dependencies beyond WebSockets
|
||||
|
||||
---
|
||||
|
||||
## 🗂️ Architecture
|
||||
|
||||
```
|
||||
Client <--> StatusServer
|
||||
^ |
|
||||
| |-- publish(info/status/warning/error)
|
||||
|<-- broadcasted messages
|
||||
```
|
||||
|
||||
- **Publish**: send a message (info, status, warning or error) to the server.
|
||||
- **Broadcast**: server pushes it to all connected subscribers.
|
Reference in New Issue
Block a user