diff options
Diffstat (limited to 'examples/tcp_echo/README.md')
| -rw-r--r-- | examples/tcp_echo/README.md | 29 |
1 files changed, 19 insertions, 10 deletions
diff --git a/examples/tcp_echo/README.md b/examples/tcp_echo/README.md index ee8a8c8..d65fae5 100644 --- a/examples/tcp_echo/README.md +++ b/examples/tcp_echo/README.md @@ -1,18 +1,27 @@ -Ranch TCP Echo -============== +Ranch TCP echo example +====================== -To compile this example you need rebar in your PATH. +To try this example, you need GNU `make` and `git` in your PATH. -Type the following command: -``` -$ rebar get-deps compile +To build the example, run the following command: + +``` bash +$ make ``` -You can then start the Erlang node with the following command: +To start the release in the foreground: + +``` bash +$ ./_rel/bin/tcp_echo_example console ``` -./start.sh + +Then start a telnet session to port 5555: + +``` bash +$ telnet localhost 5555 ``` -Then start telnet as indicated and type in a few lines. Be -aware that there is a timeout of 5 seconds without receiving +Type in a few words and see them echoed back. + +Be aware that there is a timeout of 5 seconds without receiving data before the example server disconnects your session. |