]> git.lizzy.rs Git - connect-rs.git/blobdiff - README.md
remove `block_on` in tls-listener
[connect-rs.git] / README.md
index aedb3e706397a952576dbe0c2e6568bc0b0e3f57..bdf89a06bb217deda27914be5a16712d89083fd2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,25 +1,25 @@
 # connect-rs
 
-This Rust crate provides a reliable, fault-tolerant, and brokerless message-queue abstraction over
-asynchronous network streams.
+[![Crates.io][crates-badge]][crates-url]
+[![Docs.rs][docs-badge]][docs-url]
 
-## Why?
-When building networked applications, developers shouldn't have to focus on repeatedly solving
-the problem of reliable, fault-tolerant message delivery over byte-streams. By using a message
-queue abstraction, crate users can focus on core application logic and leave the low-level
-networking and message-queue guarantees to the abstraction.
+[crates-badge]: https://img.shields.io/crates/v/connect.svg
+[crates-url]: https://crates.io/crates/connect
+[docs-badge]: https://docs.rs/connect/badge.svg
+[docs-url]: https://docs.rs/connect
 
-## Protobuf
-This crate relies on the use of [Protocol Buffers](https://developers.google.com/protocol-buffers)
-due to it being widely adopted and industry-proven. All messages are Protobuf messages that
-are packed into a Protobuf `Any` type and then sent over the wire. Message recipients must
-decide what Protobuf message type it is, and correspondingly unpack the `Any` into a particular
-message type.
+This Rust crate provides a simple brokerless message-queue abstraction over asynchronous network
+streams.
 
 ## Examples
-Please use the [examples](https://github.com/sachanganesh/connect-rs/tree/main/examples)
+Please use the [example programs](https://github.com/sachanganesh/connect-rs/tree/main/examples)
 provided to help understand crate usage.
 
+## Why?
+When building networked applications, developers shouldn't have to focus on repeatedly solving
+the problem of reliable, fault-tolerant message delivery over byte-streams. By using a message
+queue abstraction, crate users can focus on core application logic and leave the low-level
+networking and message-queue guarantees to the abstraction.
 
 ## Feature Status