aboutsummaryrefslogtreecommitdiffstats
path: root/examples/ssl_hello_world/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/ssl_hello_world/README.md')
-rw-r--r--examples/ssl_hello_world/README.md30
1 files changed, 17 insertions, 13 deletions
diff --git a/examples/ssl_hello_world/README.md b/examples/ssl_hello_world/README.md
index 766ff59..02bf13a 100644
--- a/examples/ssl_hello_world/README.md
+++ b/examples/ssl_hello_world/README.md
@@ -1,23 +1,27 @@
-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/ssl_hello_world_example console
```
-Then point your browser to the indicated URL. You will need to temporarily
-trust the root certificate authority in `priv/ssl/cowboy-ca.crt`.
+Then point your browser at [http://localhost:8443](http://localhost:8443).
+You will need to temporarily trust the root certificate authority,
+which can also be found in `priv/ssl/cowboy-ca.crt`.
-Example
--------
+Example output
+--------------
``` bash
$ curl --cacert priv/ssl/cowboy-ca.crt -i https://localhost:8443