aboutsummaryrefslogtreecommitdiffstats
path: root/examples/tcp_echo/README.md
diff options
context:
space:
mode:
authorjosh rotenberg <[email protected]>2013-12-05 17:17:01 -0800
committerjosh rotenberg <[email protected]>2013-12-05 17:19:59 -0800
commit4e5e04f66869d2a34b8d32232e1bbb0e813befba (patch)
tree7cb32cafeeafbf804cca706f3a03150c7848597a /examples/tcp_echo/README.md
parent88209ea02ea71fd8c028e76f9bf7aedbf0dfdd55 (diff)
downloadranch-4e5e04f66869d2a34b8d32232e1bbb0e813befba.tar.gz
ranch-4e5e04f66869d2a34b8d32232e1bbb0e813befba.tar.bz2
ranch-4e5e04f66869d2a34b8d32232e1bbb0e813befba.zip
Update tcp_echo example to use erlang.mk
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.