aboutsummaryrefslogtreecommitdiffstats
path: root/examples/websocket
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/websocket
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/websocket')
-rw-r--r--examples/websocket/README.asciidoc10
-rw-r--r--examples/websocket/README.md18
2 files changed, 10 insertions, 18 deletions
diff --git a/examples/websocket/README.asciidoc b/examples/websocket/README.asciidoc
new file mode 100644
index 0000000..0b22607
--- /dev/null
+++ b/examples/websocket/README.asciidoc
@@ -0,0 +1,10 @@
+= Websocket example
+
+To try this example, you need GNU `make` and `git` in your PATH.
+
+To build and run the example, use the following command:
+
+[source,bash]
+$ make run
+
+Then point your browser to http://localhost:8080
diff --git a/examples/websocket/README.md b/examples/websocket/README.md
deleted file mode 100644
index bb55c1c..0000000
--- a/examples/websocket/README.md
+++ /dev/null
@@ -1,18 +0,0 @@
-Websocket example
-=================
-
-To try this example, you need GNU `make` and `git` in your PATH.
-
-To build the example, run the following command:
-
-``` bash
-$ make
-```
-
-To start the release in the foreground:
-
-``` bash
-$ ./_rel/websocket_example/bin/websocket_example console
-```
-
-Then point your browser at [http://localhost:8080](http://localhost:8080).