aboutsummaryrefslogtreecommitdiffstats
path: root/examples/tcp_echo/README.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-12-07 13:53:00 +0100
committerLoïc Hoguin <[email protected]>2013-12-07 13:53:00 +0100
commitb0c37e853ef0600ca5b86216e427d767b6bc6126 (patch)
treef25ccf1af5d97df4665aa7bc3477592f7f59e3f2 /examples/tcp_echo/README.md
parent7194df4568e66c1f2fee86816ace3308ec9eb302 (diff)
parent4e5e04f66869d2a34b8d32232e1bbb0e813befba (diff)
downloadranch-b0c37e853ef0600ca5b86216e427d767b6bc6126.tar.gz
ranch-b0c37e853ef0600ca5b86216e427d767b6bc6126.tar.bz2
ranch-b0c37e853ef0600ca5b86216e427d767b6bc6126.zip
Merge branch 'tcp_echo_example_updates' of git://github.com/joshrotenberg/ranch
Diffstat (limited to 'examples/tcp_echo/README.md')
-rw-r--r--examples/tcp_echo/README.md23
1 files changed, 14 insertions, 9 deletions
diff --git a/examples/tcp_echo/README.md b/examples/tcp_echo/README.md
index ee8a8c8..df4c6bd 100644
--- a/examples/tcp_echo/README.md
+++ b/examples/tcp_echo/README.md
@@ -1,18 +1,23 @@
Ranch TCP Echo
==============
-To compile this example you need rebar in your PATH.
-
-Type the following command:
-```
-$ rebar get-deps compile
+To build the example:
+``` 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.