aboutsummaryrefslogtreecommitdiffstats
path: root/examples/ssl_hello_world
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/ssl_hello_world
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/ssl_hello_world')
-rw-r--r--examples/ssl_hello_world/README.asciidoc (renamed from examples/ssl_hello_world/README.md)25
1 files changed, 9 insertions, 16 deletions
diff --git a/examples/ssl_hello_world/README.md b/examples/ssl_hello_world/README.asciidoc
index 1dabbd6..d3fcf77 100644
--- a/examples/ssl_hello_world/README.md
+++ b/examples/ssl_hello_world/README.asciidoc
@@ -1,28 +1,21 @@
-Hello world example
-===================
+= Hello world 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 https://localhost:8443
-``` bash
-$ ./_rel/ssl_hello_world_example/bin/ssl_hello_world_example console
-```
-
-Then point your browser at [https://localhost:8443](https://localhost:8443).
You will need to temporarily trust the root certificate authority,
which can also be found in `priv/ssl/cowboy-ca.crt`.
-Example output
---------------
+== Example output
-``` bash
+[source,bash]
+----
$ curl --cacert priv/ssl/cowboy-ca.crt -i https://localhost:8443
HTTP/1.1 200 OK
connection: keep-alive
@@ -31,4 +24,4 @@ date: Fri, 28 Sep 2012 04:10:25 GMT
content-length: 12
Hello world!
-```
+----