aboutsummaryrefslogtreecommitdiffstats
path: root/examples/chunked_hello_world/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/chunked_hello_world/README.md')
-rw-r--r--examples/chunked_hello_world/README.md30
1 files changed, 17 insertions, 13 deletions
diff --git a/examples/chunked_hello_world/README.md b/examples/chunked_hello_world/README.md
index be8f046..7e7cf21 100644
--- a/examples/chunked_hello_world/README.md
+++ b/examples/chunked_hello_world/README.md
@@ -1,24 +1,28 @@
-Cowboy Chunked Hello World
-==========================
+Chunked hello world 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/chunked_hello_world_example console
```
-Then run the given command or point your browser to the indicated URL.
+Then point your browser at [http://localhost:8080](http://localhost:8080),
+or use `curl` to see the chunks arriving one at a time every second.
-Example
--------
+Example output
+--------------
-```bash
+``` bash
$ time curl -i http://localhost:8080
HTTP/1.1 200 OK
transfer-encoding: chunked