diff --git a/examples/echo/README.md b/examples/echo/README.md index b19176742292e3e8f0d0b75b0e654de5fa340c53..f58b9cace794d015ce9b4a31034e1214e79621b6 100644 --- a/examples/echo/README.md +++ b/examples/echo/README.md @@ -8,7 +8,7 @@ This example can be started in either listen mode, or dial mode. In listen mode, it will sit and wait for incoming connections on the `/echo/1.0.0` protocol. Whenever it receives a stream, it will write the -message "Hello, world!" over the stream and close it. +message `"Hello, world!"` over the stream and close it. In dial mode, the node will start up, connect to the given address, open a stream to the target peer, and read a message on the protocol `/echo/1.0.0`. @@ -19,16 +19,14 @@ From `go-libp2p` base folder: ``` > make deps -> go build ./examples/hosts +> go build ./examples/echo ``` ## Usage -In one terminal: - ``` -> ./hosts -l 1235 -2016/11/10 10:45:37 I am /ip4/127.0.0.1/tcp/1234/ipfs/QmNtX1cvrm2K6mQmMEaMxAuB4rTexhd87vpYVot4sEZzxc +> ./echo -l 1235 +2016/11/10 10:45:37 I am /ip4/127.0.0.1/tcp/1235/ipfs/QmNtX1cvrm2K6mQmMEaMxAuB4rTexhd87vpYVot4sEZzxc 2016/11/10 10:45:37 listening for connections ``` @@ -38,15 +36,13 @@ can be reached (ip4+tcp) and its randomly generated ID (`QmNtX1cv...`) Now, launch another node that talks to the listener: ``` -> ./hosts -d /ip4/127.0.0.1/tcp/1234/ipfs/QmNtX1cvrm2K6mQmMEaMxAuB4rTexhd87vpYVot4sEZzxc -l 1236 +> ./echo -d /ip4/127.0.0.1/tcp/1235/ipfs/QmNtX1cvrm2K6mQmMEaMxAuB4rTexhd87vpYVot4sEZzxc -l 1236 ``` - -The new node with send the message `Hello, world!` to the +The new node with send the message `"Hello, world!"` to the listener, which will in turn echo it over the stream and close it. The listener logs the message, and the sender logs the response. - ## Details The `makeBasicHost()` function creates a