Add a TCP Echo protocol example

1 files changed, 18 insertions, 0 deletions

diff --git a/examples/tcp_echo/README.md b/examples/tcp_echo/README.md
new file mode 100644
index 0000000..ee8a8c8
--- /dev/null
+++ b/examples/tcp_echo/README.md
@@ -0,0 +1,18 @@
+Ranch TCP Echo
+==============
+
+To compile this example you need rebar in your PATH.
+
+Type the following command:
+```
+$ rebar get-deps compile
+```
+
+You can then start the Erlang node with the following command:
+```
+./start.sh
+```
+
+Then start telnet as indicated and type in a few lines. Be
+aware that there is a timeout of 5 seconds without receiving
+data before the example server disconnects your session.