aboutsummaryrefslogtreecommitdiffstats
path: root/examples/echo_get/README.asciidoc
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/README.asciidoc
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/README.asciidoc')
-rw-r--r--examples/echo_get/README.asciidoc28
1 files changed, 28 insertions, 0 deletions
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
+----