aboutsummaryrefslogtreecommitdiffstats
path: root/examples/compress_response
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/compress_response
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/compress_response')
-rw-r--r--examples/compress_response/README.asciidoc (renamed from examples/compress_response/README.md)31
1 files changed, 12 insertions, 19 deletions
diff --git a/examples/compress_response/README.md b/examples/compress_response/README.asciidoc
index ecffcad..1e6d2ed 100644
--- a/examples/compress_response/README.md
+++ b/examples/compress_response/README.asciidoc
@@ -1,28 +1,20 @@
-Compressed response example
-===========================
+= Compressed response 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/compress_response_example/bin/compress_response_example console
-```
-
-Then point your browser at [http://localhost:8080](http://localhost:8080).
-
-Example output
---------------
+== Example output
Without compression:
-``` bash
+[source,bash]
+----
$ curl -i http://localhost:8080
HTTP/1.1 200 OK
connection: keep-alive
@@ -42,11 +34,12 @@ have established the ability to work at virtually identical tasks and obtained
considerable respect for their achievements. There are also cattle handlers
in many other parts of the world, particularly South America and Australia,
who perform work similar to the cowboy in their respective nations.
-```
+----
With compression:
-```
+[source,bash]
+----
$ curl -i --compressed http://localhost:8080
HTTP/1.1 200 OK
connection: keep-alive
@@ -67,4 +60,4 @@ have established the ability to work at virtually identical tasks and obtained
considerable respect for their achievements. There are also cattle handlers
in many other parts of the world, particularly South America and Australia,
who perform work similar to the cowboy in their respective nations.
-```
+----