aboutsummaryrefslogtreecommitdiffstats
path: root/examples/echo_post
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_post
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_post')
-rw-r--r--examples/echo_post/README.asciidoc (renamed from examples/echo_post/README.md)24
1 files changed, 8 insertions, 16 deletions
diff --git a/examples/echo_post/README.md b/examples/echo_post/README.asciidoc
index cc89fd6..144e216 100644
--- a/examples/echo_post/README.md
+++ b/examples/echo_post/README.asciidoc
@@ -1,29 +1,21 @@
-POST parameter echo example
-===========================
+= POST 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
-```
-
-To start the release in the foreground:
-
-``` bash
-$ ./_rel/echo_post_example/bin/echo_post_example console
-```
+[source,bash]
+$ make run
As this example echoes a POST parameter, it is a little more
complex to test. Some browsers feature tools that allow you
to perform one such request, or you can use the command line
tool `curl` as we will demonstrate.
-Example output
---------------
+== Example output
-``` bash
+[source,bash]
+----
$ curl -i -d echo=echomeplz http://localhost:8080
HTTP/1.1 200 OK
connection: keep-alive
@@ -33,4 +25,4 @@ content-length: 9
content-type: text/plain; charset=utf-8
echomeplz
-```
+----