bump version and update README.md to mirror docs

diff --git a/Cargo.lock b/Cargo.lock
index e81e23a8f25b1a92d3df7029fbfeae8f11c41159..01e4369b11430c7128b2d7c0e4407cdbdfc7114e 100644 (file)
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -257,7 +257,7 @@ dependencies = [
 
 [[package]]
 name = "connect"
-version = "0.0.3"
+version = "0.0.4"
 dependencies = [
  "anyhow",
  "async-channel",

diff --git a/Cargo.toml b/Cargo.toml
index b52726656e3a24faad1e44dead518a948584d3d9..55ce619e4f877bab55e7198da7d2980fa4f5fa30 100644 (file)
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "connect"
-version = "0.0.3"
+version = "0.0.4"
 edition = "2018"
 authors = ["Sachandhan Ganesh <sachan.ganesh@gmail.com>"]
 description = "message queue abstraction over async network streams"

diff --git a/README.md b/README.md
index abed80675ebca1dd4f1300a496ca3245e59144e5..4c6a834aa47454710b9ba9bfc9e4156b2bb4ceb1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,8 +1,25 @@
-# connect
+# connect-rs
 
-This crate provides a distributed message queue abstraction over asynchronous network streams.
+This Rust crate provides a reliable, fault-tolerant, and brokerless message-queue abstraction over
+asynchronous network streams.
+
+## 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.
+
+# 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.
+
+# Examples
+Please use the [examples](https://github.com/sachanganesh/connect-rs/tree/main/examples)
+provided to help understand crate usage.
 
-By using a message queue, crate users can focus on sending and receiving messages between clients instead of low-level networking and failure recovery.
 
 ## Feature Status
 
@@ -16,6 +33,3 @@ By using a message queue, crate users can focus on sending and receiving message
 | SCTP Server                                          |               |
 | DTLS-SCTP Client                                     |               |
 | DTLS-SCTP Server                                     |               |
-
-
-## Why Protobuf?
\ No newline at end of file