From 6ebdebd5c2f5078b9861152830a9719079c3930c Mon Sep 17 00:00:00 2001
From: Filip Bozic <70634661+fbozic@users.noreply.github.com>
Date: Mon, 20 May 2024 19:40:26 +0200
Subject: [PATCH] docs: update readme

---
 examples/chat/README.md | 38 +++++++++-----------------------------
 1 file changed, 9 insertions(+), 29 deletions(-)

diff --git a/examples/chat/README.md b/examples/chat/README.md
index bf5a474..d400e6f 100644
--- a/examples/chat/README.md
+++ b/examples/chat/README.md
@@ -1,44 +1,24 @@
 # Chat 
-This examples show cases how to manually dial (connect to) either local peer or remote peer has a reservation on relay-server. 
+This examples show cases how to build chat application with DCUtR, mDNS, Relay, Rendezvous and GossipSub protocols.
+- Local node gets reservation on the relay.
+- Local node advertises relayed address at the Rendezvous node.
+- Local nodes discovers other local nodes via mDNS discovery and attempts direct connection.
+- Local nodes discovers other remote nodes via Rendezvous discovery and attempts hole punched connectioned.
 
-## Run local only
-This examples shows how to run two sessions locally and connect sessions by manually dialing local peer.
-
-Run first chat session in echo mode.
-```
-cargo run -p chat-example -- --mode echo --port 4002 --secret-key-seed 102 --gossip-topic-names calimero-network/examples/chat/v0.0.1 --relay-address /ip4/3.71.239.80/udp/4001/quic-v1/p2p/12D3KooWAgFah4EZtWnMMGMUddGdJpb5cq2NubNCAD2jA5AZgbXF
-```
-
-Run second chat session in interactive mode with local peer dial.
-```
-cargo run -p chat-example -- --mode interactive --port 4003 --secret-key-seed 103 --gossip-topic-names calimero-network/examples/chat/v0.0.1 --dial-peer-addrs /ip4/127.0.0.1/udp/4002/quic-v1/p2p/12D3KooWMpeKAbMK4BTPsQY3rG7XwtdstseHGcq7kffY8LToYYKK --relay-address /ip4/3.71.239.80/udp/4001/quic-v1/p2p/12D3KooWAgFah4EZtWnMMGMUddGdJpb5cq2NubNCAD2jA5AZgbXF
-```
-
-In the interactive session publish new message manually:
-```
-publish calimero-network/examples/chat/v0.0.1 ola
-```
-
-## Run locally with remote peer dial in
-This examples shows how to run two sessions locally and connect sessions manually by dialing private remote peer from each session. For the gossip message to pass from one local session to second local session it needs to go "the long way" around (local -> remote -> local).
-
-Additional info:
-- Remote instance is running in a private subnet behind NAT.
-- Remote instance PeerId: `12D3KooWP285Hw3CSTdr9oU6Ezz4hDoi6XS5vfDjjNeTJ1uFMGvp`
-- Remote instance address at the relay server: `ip4/3.71.239.80/udp/4001/quic-v1/p2p/12D3KooWAgFah4EZtWnMMGMUddGdJpb5cq2NubNCAD2jA5AZgbXF/p2p-circuit/p2p/12D3KooWP285Hw3CSTdr9oU6Ezz4hDoi6XS5vfDjjNeTJ1uFMGvp`
+## Run
 Run first chat session in interactive mode with remote peer dial.
 ```
-cargo run -p chat-example -- --mode interactive --port 4002 --secret-key-seed 102 --gossip-topic-names calimero-network/examples/chat/v0.0.1 --dial-peer-addrs /ip4/3.71.239.80/udp/4001/quic-v1/p2p/12D3KooWAgFah4EZtWnMMGMUddGdJpb5cq2NubNCAD2jA5AZgbXF/p2p-circuit/p2p/12D3KooWP285Hw3CSTdr9oU6Ezz4hDoi6XS5vfDjjNeTJ1uFMGvp --relay-address /ip4/3.71.239.80/udp/4001/quic-v1/p2p/12D3KooWAgFah4EZtWnMMGMUddGdJpb5cq2NubNCAD2jA5AZgbXF
+cargo run -p chat-example -- --mode interactive --port 4002 --secret-key-seed 102 --gossip-topic-names calimero-network/examples/chat/v0.0.2 --boot-nodes /ip4/35.156.78.13/udp/4001/quic-v1/p2p/12D3KooWRnt7EmBwrNALhAXAgM151MdH7Ka9tvYS91ZUqnqwpjVg
 ```
 
 Run second chat session in interactive mode with remote peer dial.
 ```
-cargo run -p chat-example -- --mode interactive --port 4003 --secret-key-seed 103 --gossip-topic-names calimero-network/examples/chat/v0.0.1 --dial-peer-addrs /ip4/3.71.239.80/udp/4001/quic-v1/p2p/12D3KooWAgFah4EZtWnMMGMUddGdJpb5cq2NubNCAD2jA5AZgbXF/p2p-circuit/p2p/12D3KooWP285Hw3CSTdr9oU6Ezz4hDoi6XS5vfDjjNeTJ1uFMGvp --relay-address /ip4/3.71.239.80/udp/4001/quic-v1/p2p/12D3KooWAgFah4EZtWnMMGMUddGdJpb5cq2NubNCAD2jA5AZgbXF
+cargo run -p chat-example -- --mode interactive --port 4003 --secret-key-seed 103 --gossip-topic-names calimero-network/examples/chat/v0.0.2 --boot-nodes /ip4/35.156.78.13/udp/4001/quic-v1/p2p/12D3KooWRnt7EmBwrNALhAXAgM151MdH7Ka9tvYS91ZUqnqwpjVg
 ```
 
 In any interactive session publish new message manually:
 ```
-publish calimero-network/examples/chat/v0.0.1 ola
+publish calimero-network/examples/chat/v0.0.2 ola
 ```
 
 ## Debugging and known issues