aboutsummaryrefslogtreecommitdiffstats
path: root/examples/echo_get/README.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-09-07 22:26:40 +0200
committerLoïc Hoguin <[email protected]>2013-09-07 22:26:40 +0200
commite2b11bbeedc0f7114910bb04bcb842d25e789427 (patch)
treed0e00d9758a04ea9f88b9357d07d9f0da768947b /examples/echo_get/README.md
parent340f0a51123b476bca765b87d3f36411e896b5e3 (diff)
downloadcowboy-e2b11bbeedc0f7114910bb04bcb842d25e789427.tar.gz
cowboy-e2b11bbeedc0f7114910bb04bcb842d25e789427.tar.bz2
cowboy-e2b11bbeedc0f7114910bb04bcb842d25e789427.zip
Convert the GET echo example to a release
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
```