aboutsummaryrefslogtreecommitdiffstats
path: root/examples/rest_hello_world
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/rest_hello_world
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/rest_hello_world')
-rw-r--r--examples/rest_hello_world/README.asciidoc (renamed from examples/rest_hello_world/README.md)41
1 files changed, 18 insertions, 23 deletions
diff --git a/examples/rest_hello_world/README.md b/examples/rest_hello_world/README.asciidoc
index c7e124c..5eb94e8 100644
--- a/examples/rest_hello_world/README.md
+++ b/examples/rest_hello_world/README.asciidoc
@@ -1,28 +1,20 @@
-REST hello world example
-========================
+= REST hello world 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
-``` bash
-$ ./_rel/rest_hello_world_example/bin/rest_hello_world_example console
-```
-
-Then point your browser at [http://localhost:8080](http://localhost:8080).
-
-Example output
---------------
+== Example output
Request HTML:
-``` bash
+[source,bash]
+----
$ curl -i http://localhost:8080
HTTP/1.1 200 OK
connection: keep-alive
@@ -41,11 +33,12 @@ vary: Accept
<p>REST Hello World as HTML!</p>
</body>
</html>
-```
+----
Request JSON:
-``` bash
+[source,bash]
+----
$ curl -i -H "Accept: application/json" http://localhost:8080
HTTP/1.1 200 OK
connection: keep-alive
@@ -56,11 +49,12 @@ content-type: application/json
vary: Accept
{"rest": "Hello World!"}
-```
+----
Request plain text:
-``` bash
+[source,bash]
+----
$ curl -i -H "Accept: text/plain" http://localhost:8080
HTTP/1.1 200 OK
connection: keep-alive
@@ -71,11 +65,12 @@ content-type: text/plain
vary: Accept
REST Hello World as text!
-```
+----
Request a non acceptable content-type:
-``` bash
+[source,bash]
+----
$ curl -i -H "Accept: text/css" http://localhost:8080
HTTP/1.1 406 Not Acceptable
connection: keep-alive
@@ -83,4 +78,4 @@ server: Cowboy
date: Fri, 28 Sep 2012 04:18:51 GMT
content-length: 0
-```
+----