From bb9a2e975e4657d2f03d93b4d9595160e8190566 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Sat, 7 Sep 2013 16:23:13 +0200
Subject: Rename the basic_auth example to rest_basic_auth

---
 examples/rest_basic_auth/README.md | 48 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 examples/rest_basic_auth/README.md

(limited to 'examples/rest_basic_auth/README.md')

diff --git a/examples/rest_basic_auth/README.md b/examples/rest_basic_auth/README.md
new file mode 100644
index 0000000..eea6fd9
--- /dev/null
+++ b/examples/rest_basic_auth/README.md
@@ -0,0 +1,48 @@
+Basic authorization example using REST
+======================================
+
+To try this example, you need GNU `make`, `git` and
+[relx](https://github.com/erlware/relx) in your PATH.
+
+To build the example, run the following command:
+
+``` bash
+$ make
+```
+
+To start the release in the foreground:
+
+``` bash
+$ ./_rel/bin/hello_world_example console
+```
+
+Then point your browser at [http://localhost:8080](http://localhost:8080).
+
+Example output
+--------------
+
+Request with no authentication:
+
+``` bash
+$ curl -i http://localhost:8080
+HTTP/1.1 401 Unauthorized
+connection: keep-alive
+server: Cowboy
+date: Sun, 20 Jan 2013 14:10:27 GMT
+content-length: 0
+www-authenticate: Basic realm="cowboy"
+```
+
+Request with authentication:
+
+``` bash
+$ curl -i -u "Alladin:open sesame" http://localhost:8080
+HTTP/1.1 200 OK
+connection: keep-alive
+server: Cowboy
+date: Sun, 20 Jan 2013 14:11:12 GMT
+content-length: 16
+content-type: text/plain
+
+Hello, Alladin!
+```
-- 
cgit v1.2.3