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_get/README.asciidoc | 28 ++++++++++++++++++++++++++++ examples/echo_get/README.md | 36 ------------------------------------ 2 files changed, 28 insertions(+), 36 deletions(-) create mode 100644 examples/echo_get/README.asciidoc delete mode 100644 examples/echo_get/README.md (limited to 'examples/echo_get') diff --git a/examples/echo_get/README.asciidoc b/examples/echo_get/README.asciidoc new file mode 100644 index 0000000..d002d61 --- /dev/null +++ b/examples/echo_get/README.asciidoc @@ -0,0 +1,28 @@ += GET 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 + +Then point your browser to 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 + +[source,bash] +---- +$ curl -i "http://localhost:8080/?echo=saymyname" +HTTP/1.1 200 OK +connection: keep-alive +server: Cowboy +date: Fri, 28 Sep 2012 04:09:04 GMT +content-length: 9 +content-type: text/plain; charset=utf-8 + +saymyname +---- diff --git a/examples/echo_get/README.md b/examples/echo_get/README.md deleted file mode 100644 index 737d04d..0000000 --- a/examples/echo_get/README.md +++ /dev/null @@ -1,36 +0,0 @@ -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: - -``` bash -$ make -``` - -To start the release in the foreground: - -``` 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 --------------- - -``` bash -$ curl -i "http://localhost:8080/?echo=saymyname" -HTTP/1.1 200 OK -connection: keep-alive -server: Cowboy -date: Fri, 28 Sep 2012 04:09:04 GMT -content-length: 9 -content-type: text/plain; charset=utf-8 - -saymyname -``` -- cgit v1.2.3