aboutsummaryrefslogtreecommitdiffstats
path: root/examples/web_server/README.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-09-09 16:10:58 +0200
committerLoïc Hoguin <[email protected]>2013-09-09 16:10:58 +0200
commit6a90d00ceee9c95d5d80190736e04f35bd04d8f4 (patch)
treec9a388e324260d0213bdf7fd354a8eed06e6eb0f /examples/web_server/README.md
parent8bb7c180ff3a169557e24c8eb7e3e8e4b5645cbf (diff)
downloadcowboy-6a90d00ceee9c95d5d80190736e04f35bd04d8f4.tar.gz
cowboy-6a90d00ceee9c95d5d80190736e04f35bd04d8f4.tar.bz2
cowboy-6a90d00ceee9c95d5d80190736e04f35bd04d8f4.zip
Convert the web_server example to a release
Temporary mimetypes list here too.
Diffstat (limited to 'examples/web_server/README.md')
-rw-r--r--examples/web_server/README.md33
1 files changed, 13 insertions, 20 deletions
diff --git a/examples/web_server/README.md b/examples/web_server/README.md
index c123c98..b81a955 100644
--- a/examples/web_server/README.md
+++ b/examples/web_server/README.md
@@ -1,27 +1,20 @@
-Cowboy Static File Handler with Index Support
-=============================================
+Static file handler 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. You can replace
-the filename given in the example URL with the one of a file you added to this
-directory to receive that file. A middleware has been added that will re-route
-the request to a different handler if the requested path is a directory.
+To start the release in the foreground:
-Example
--------
+``` bash
+$ ./_rel/bin/web_server_example console
+```
-Point your browser to http://localhost:8080 to see the contents of `priv/`. You
-can click on a link to see that file. If HTML is not preferred, the contents of
-a directory will be listed as a JSON array (e.g. with `curl
-http://localhost:8080`).
+Then point your browser at [http://localhost:8080](http://localhost:8080)
+to browse the contents of the `priv` directory.