Merge branch 'websocket-example' of https://github.com/pvieytes/cowboy

1 files changed, 17 insertions, 0 deletions

diff --git a/examples/websocket/README.md b/examples/websocket/README.md
new file mode 100644
index 0000000..f3b4cbd
--- /dev/null
+++ b/examples/websocket/README.md
@@ -0,0 +1,17 @@
+Cowboy websocket
+================
+
+To compile this example you need rebar in your PATH.
+
+Type the following command:
+```
+$ rebar get-deps compile
+```
+
+You can then start the Erlang node with the following command:
+```
+./start.sh
+```
+
+Then point your browser to the indicated URL to open a websocket client.
+Not all browsers support websockets. It was tested with Chromium.