aboutsummaryrefslogtreecommitdiffstats
path: root/examples/echo_get/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/echo_get/README.md')
-rw-r--r--examples/echo_get/README.md33
1 files changed, 19 insertions, 14 deletions
diff --git a/examples/echo_get/README.md b/examples/echo_get/README.md
index 233ae05..28f9d0c 100644
--- a/examples/echo_get/README.md
+++ b/examples/echo_get/README.md
@@ -1,23 +1,28 @@
-Cowboy GET Echo
-===============
+GET parameter echo example
+==========================
-To compile this example you need rebar in your PATH.
+To try this example, you need GNU `make`, `git` and
+[relx](https://github.com/erlware/relx) in your PATH.
-Type the following command:
-```
-$ rebar get-deps compile
-```
+To build the example, run the following command:
-You can then start the Erlang node with the following command:
+``` bash
+$ make
```
-./start.sh
+
+To start the release in the foreground:
+
+``` bash
+$ ./_rel/bin/get_echo_example console
```
-Then point your browser to the indicated URL. You can change
-the GET parameter to check that the handler is echoing properly.
+Then point your browser at
+[http://localhost:8080/?echo=hello](http://localhost:8080/?echo=hello).
+You can replace the `echo` parameter with another to check
+that the handler is echoing it back properly.
-Example
--------
+Example output
+--------------
``` bash
$ curl -i "http://localhost:8080/?echo=saymyname"
@@ -26,7 +31,7 @@ connection: keep-alive
server: Cowboy
date: Fri, 28 Sep 2012 04:09:04 GMT
content-length: 9
-Content-Encoding: utf-8
+content-type: text/plain; charset=utf-8
saymyname
```