diff options
Diffstat (limited to 'examples/tcp_reverse/README.md')
| -rw-r--r-- | examples/tcp_reverse/README.md | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/examples/tcp_reverse/README.md b/examples/tcp_reverse/README.md index c73ae60..6a17772 100644 --- a/examples/tcp_reverse/README.md +++ b/examples/tcp_reverse/README.md @@ -1,13 +1,16 @@ -Ranch TCP Reverse -================= +Ranch TCP reverse example +========================= -This example uses a gen_server to handle a protocol to revese input. See -reverse_protocol.erl for the implementation, and documentation at -the following URL: +This example uses a `gen_server` to handle a protocol to revese input. +See `reverse_protocol.erl` for the implementation. Documentation about +this topic can be found in the guide: -http://ninenines.eu/docs/en/ranch/HEAD/guide/protocols/#using_gen_server + http://ninenines.eu/docs/en/ranch/HEAD/guide/protocols/#using_gen_server + +To try this example, you need GNU `make` and `git` in your PATH. + +To build the example, run the following command: -To build the example: ``` bash $ make ``` @@ -19,6 +22,7 @@ $ ./_rel/bin/tcp_reverse_example console ``` Then start a telnet session to port 5555: + ``` bash $ telnet localhost 5555 ``` |