refactor to have datagram already serialized in memory

[connect-rs.git] / examples / tcp-client-blaster / README.md

diff --git a/examples/tcp-client-blaster/README.md b/examples/tcp-client-blaster/README.md
new file mode 100644 (file)
index 0000000..9246863
--- /dev/null
+++ b/examples/tcp-client-blaster/README.md
@@ -0,0 +1,22 @@
+# connect tcp-client-blaster example
+
+This example program will:
+
+1. Establish a connection with a TCP server
+2. Send a number of `String` messages to the server
+3. Wait for `String` messages reply from the server
+4. Validate that the messages are received in the correct order
+
+## Usage
+
+```
+export RUST_LOG=info
+cargo run <ip-address-to-connect-to>
+```
+
+## Example Usage
+
+```
+export RUST_LOG=info
+cargo run localhost:5678
+```
\ No newline at end of file