aboutsummaryrefslogtreecommitdiffstats
path: root/examples/hello_world/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/hello_world/README.md')
-rw-r--r--examples/hello_world/README.md28
1 files changed, 16 insertions, 12 deletions
diff --git a/examples/hello_world/README.md b/examples/hello_world/README.md
index dd3d948..84f3211 100644
--- a/examples/hello_world/README.md
+++ b/examples/hello_world/README.md
@@ -1,22 +1,25 @@
-Cowboy Hello World
-==================
+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/hello_world_example console
```
-Then point your browser to the indicated URL.
+Then point your browser at [http://localhost:8080](http://localhost:8080).
-Example
--------
+Example output
+--------------
``` bash
$ curl -i http://localhost:8080
@@ -25,6 +28,7 @@ connection: keep-alive
server: Cowboy
date: Fri, 28 Sep 2012 04:10:25 GMT
content-length: 12
+content-type: text/plain
Hello world!
```