aboutsummaryrefslogtreecommitdiffstats
path: root/examples/echo_get
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2016-01-14 20:00:50 +0100
committerLoïc Hoguin <[email protected]>2016-01-14 20:00:50 +0100
commit394b4f0bf7f2a4d496ffe69c8e30cff153d69532 (patch)
tree82c3d7634f93596ec42b41050b4130805a359359 /examples/echo_get
parent4023e7f4e429179fd9c2cce4487c33646c6bd327 (diff)
downloadcowboy-394b4f0bf7f2a4d496ffe69c8e30cff153d69532.tar.gz
cowboy-394b4f0bf7f2a4d496ffe69c8e30cff153d69532.tar.bz2
cowboy-394b4f0bf7f2a4d496ffe69c8e30cff153d69532.zip
Simplify example instructions and fix broken examples
Also convert to AsciiDoc while we're at it.
Diffstat (limited to 'examples/echo_get')
-rw-r--r--examples/echo_get/README.asciidoc (renamed from examples/echo_get/README.md)26
1 files changed, 9 insertions, 17 deletions
diff --git a/examples/echo_get/README.md b/examples/echo_get/README.asciidoc
index 737d04d..d002d61 100644
--- a/examples/echo_get/README.md
+++ b/examples/echo_get/README.asciidoc
@@ -1,29 +1,21 @@
-GET parameter echo example
-==========================
+= GET parameter echo example
To try this example, you need GNU `make` and `git` in your PATH.
-To build the example, run the following command:
+To build and run the example, use the following command:
-``` bash
-$ make
-```
+[source,bash]
+$ make run
-To start the release in the foreground:
+Then point your browser to http://localhost:8080/?echo=hello
-``` bash
-$ ./_rel/echo_get_example/bin/echo_get_example console
-```
-
-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 output
---------------
+== Example output
-``` bash
+[source,bash]
+----
$ curl -i "http://localhost:8080/?echo=saymyname"
HTTP/1.1 200 OK
connection: keep-alive
@@ -33,4 +25,4 @@ content-length: 9
content-type: text/plain; charset=utf-8
saymyname
-```
+----