aboutsummaryrefslogtreecommitdiffstats
path: root/examples/markdown_middleware/README.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-10-22 09:10:24 +0200
committerLoïc Hoguin <[email protected]>2013-10-22 09:10:24 +0200
commit36ba1742245bc5e294d792b9193de07c628e1387 (patch)
treebbc3a45adcabfa668e682a326fd494e2a84b646d /examples/markdown_middleware/README.md
parent4769412daaff2be53cb7d7391d0a196acb6346c3 (diff)
downloadcowboy-36ba1742245bc5e294d792b9193de07c628e1387.tar.gz
cowboy-36ba1742245bc5e294d792b9193de07c628e1387.tar.bz2
cowboy-36ba1742245bc5e294d792b9193de07c628e1387.zip
Convert the markdown_middleware example to a release
Diffstat (limited to 'examples/markdown_middleware/README.md')
-rw-r--r--examples/markdown_middleware/README.md35
1 files changed, 18 insertions, 17 deletions
diff --git a/examples/markdown_middleware/README.md b/examples/markdown_middleware/README.md
index af7937f..3c63f59 100644
--- a/examples/markdown_middleware/README.md
+++ b/examples/markdown_middleware/README.md
@@ -1,24 +1,25 @@
-Cowboy Middleware
-=================
+Middleware 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
```
-Cowboy will serve all the files you put in the priv/ directory. If you request
-a .html file that has corresponding .md file that has been modified more
-recently than the .html file, the markdown file will be converted to HTML and
-served by Cowboy.
+To start the release in the foreground:
+
+``` bash
+$ ./_rel/bin/hello_world_example console
+```
-HTML5 Video Example
--------------------
+Then point your browser at
+[http://localhost:8080/video.html](http://localhost:8080/video.html).
-Open http://localhost:8080/video.html in your favorite browser.
+Cowboy will serve all the files you put in the `priv` directory.
+If you request a `.html` file that has a corresponding `.md` file
+that has been modified more recently than the `.html` file, the
+Markdown file will be converted to HTML and served by Cowboy.