diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..a6392c5 --- /dev/null +++ b/readme.md @@ -0,0 +1,23 @@ +# smthqueue + +A simple queue system for simple cases. It provide a various options to +interact with the server: + +* gRPC, via streams +* WebSockets +* HTTP/1.0 by polling +* Direct-connect via TCP + +## Core functions + +Subscribe to message queues and message queue groups. Publish and consume +messages. + +* Support clustering, allowing to run distributed nodes on separate hosts +for scaling purposes. + +Support mesh network allowing star-connection between clients. + +## Concept + +Clients connected to mesh network, communicates using TCP.