aboutsummaryrefslogtreecommitdiffstats
path: root/examples/compress_response/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/compress_response/README.md')
-rw-r--r--examples/compress_response/README.md33
1 files changed, 21 insertions, 12 deletions
diff --git a/examples/compress_response/README.md b/examples/compress_response/README.md
index 8afbe65..aa352c9 100644
--- a/examples/compress_response/README.md
+++ b/examples/compress_response/README.md
@@ -1,22 +1,27 @@
-Cowboy Compress Response
-========================
+Compressed response example
+===========================
-To compile this example you need rebar in your PATH.
+To try this example, you need GNU `make`, `git` and
+[relx](https://github.com/erlware/relx) in your PATH.
-Type the following command:
-```
-$ rebar get-deps compile
-```
+To build the example, run the following command:
-You can then start the Erlang node with the following command:
+``` bash
+$ make
```
-./start.sh
+
+To start the release in the foreground:
+
+``` bash
+$ ./_rel/bin/compress_response_example console
```
-Then point your browser to the indicated URL.
+Then point your browser at [http://localhost:8080](http://localhost:8080).
+
+Example output
+--------------
-Example
--------
+Without compression:
``` bash
$ curl -i http://localhost:8080
@@ -38,7 +43,11 @@ 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:
+
+```
$ curl -i --compressed http://localhost:8080
HTTP/1.1 200 OK
connection: keep-alive