From 394b4f0bf7f2a4d496ffe69c8e30cff153d69532 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Thu, 14 Jan 2016 20:00:50 +0100 Subject: Simplify example instructions and fix broken examples Also convert to AsciiDoc while we're at it. --- examples/echo_post/README.asciidoc | 28 ++++++++++++++++++++++++++++ examples/echo_post/README.md | 36 ------------------------------------ 2 files changed, 28 insertions(+), 36 deletions(-) create mode 100644 examples/echo_post/README.asciidoc delete mode 100644 examples/echo_post/README.md (limited to 'examples/echo_post') diff --git a/examples/echo_post/README.asciidoc b/examples/echo_post/README.asciidoc new file mode 100644 index 0000000..144e216 --- /dev/null +++ b/examples/echo_post/README.asciidoc @@ -0,0 +1,28 @@ += POST parameter echo example + +To try this example, you need GNU `make` and `git` in your PATH. + +To build and run the example, use the following command: + +[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 + +[source,bash] +---- +$ curl -i -d echo=echomeplz http://localhost:8080 +HTTP/1.1 200 OK +connection: keep-alive +server: Cowboy +date: Fri, 28 Sep 2012 04:12:36 GMT +content-length: 9 +content-type: text/plain; charset=utf-8 + +echomeplz +---- diff --git a/examples/echo_post/README.md b/examples/echo_post/README.md deleted file mode 100644 index cc89fd6..0000000 --- a/examples/echo_post/README.md +++ /dev/null @@ -1,36 +0,0 @@ -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: - -``` bash -$ make -``` - -To start the release in the foreground: - -``` bash -$ ./_rel/echo_post_example/bin/echo_post_example console -``` - -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 --------------- - -``` bash -$ curl -i -d echo=echomeplz http://localhost:8080 -HTTP/1.1 200 OK -connection: keep-alive -server: Cowboy -date: Fri, 28 Sep 2012 04:12:36 GMT -content-length: 9 -content-type: text/plain; charset=utf-8 - -echomeplz -``` -- cgit v1.2.3