aboutsummaryrefslogtreecommitdiffstats
path: root/examples/eventsource/README.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-09-08 11:48:48 +0200
committerLoïc Hoguin <[email protected]>2013-09-08 11:48:48 +0200
commit49acfce8b9d0af8cc87b9be7ba91ffde307596da (patch)
treec7727f3f520b3d66401951004d9d4eac575f5380 /examples/eventsource/README.md
parent6b7b0efd24149d81df47b3241a989a6777bb486b (diff)
downloadcowboy-49acfce8b9d0af8cc87b9be7ba91ffde307596da.tar.gz
cowboy-49acfce8b9d0af8cc87b9be7ba91ffde307596da.tar.bz2
cowboy-49acfce8b9d0af8cc87b9be7ba91ffde307596da.zip
Convert the EventSource example to a release
Diffstat (limited to 'examples/eventsource/README.md')
-rw-r--r--examples/eventsource/README.md28
1 files changed, 13 insertions, 15 deletions
diff --git a/examples/eventsource/README.md b/examples/eventsource/README.md
index c9662a1..a748b06 100644
--- a/examples/eventsource/README.md
+++ b/examples/eventsource/README.md
@@ -1,22 +1,20 @@
-Cowboy EventSource
-==================
+EventSource 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:
-```
-./start.sh
+``` bash
+$ make
```
-Uses Cowboy's loop functionality to continuously send events to the browser.
+To start the release in the foreground:
-Example
--------
+``` bash
+$ ./_rel/bin/eventsource_example console
+```
-Point your browser to http://localhost:8080 to see EventSource in action with
-any modern browser (not IE).
+Then point your EventSource capable browser at
+[http://localhost:8080](http://localhost:8080).