aboutsummaryrefslogtreecommitdiffstats
path: root/examples/websocket/README.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-09-09 16:21:53 +0200
committerLoïc Hoguin <[email protected]>2013-09-09 16:21:53 +0200
commit834056402ac4a94baa1ab622f127dfdd84826bc3 (patch)
tree41df4341045ae9309e15dbd4f7812d18048e4e7b /examples/websocket/README.md
parent6a90d00ceee9c95d5d80190736e04f35bd04d8f4 (diff)
downloadcowboy-834056402ac4a94baa1ab622f127dfdd84826bc3.tar.gz
cowboy-834056402ac4a94baa1ab622f127dfdd84826bc3.tar.bz2
cowboy-834056402ac4a94baa1ab622f127dfdd84826bc3.zip
Convert the websocket example to a release
Diffstat (limited to 'examples/websocket/README.md')
-rw-r--r--examples/websocket/README.md24
1 files changed, 13 insertions, 11 deletions
diff --git a/examples/websocket/README.md b/examples/websocket/README.md
index f3b4cbd..d4e3982 100644
--- a/examples/websocket/README.md
+++ b/examples/websocket/README.md
@@ -1,17 +1,19 @@
-Cowboy websocket
-================
+Websocket 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/websocket_example console
```
-Then point your browser to the indicated URL to open a websocket client.
-Not all browsers support websockets. It was tested with Chromium.
+Then point your browser at [http://localhost:8080](http://localhost:8080).