aboutsummaryrefslogtreecommitdiffstats
path: root/guide
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-02-11 09:26:13 +0100
committerLoïc Hoguin <[email protected]>2013-02-11 09:26:13 +0100
commitc1bf0a2792673f5f43b3b72a168397d5a2c87507 (patch)
treefd6fa9c272cb72ffb108f94d113923747cf98a78 /guide
parent40b8d0befcd8b310a7a48e07df7d629153903cca (diff)
downloadcowboy-c1bf0a2792673f5f43b3b72a168397d5a2c87507.tar.gz
cowboy-c1bf0a2792673f5f43b3b72a168397d5a2c87507.tar.bz2
cowboy-c1bf0a2792673f5f43b3b72a168397d5a2c87507.zip
Add a few directions in the REST chapter in the guide
This is obviously not proper documentation. We will properly document it when the API stabilizes.
Diffstat (limited to 'guide')
-rw-r--r--guide/rest_handlers.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/guide/rest_handlers.md b/guide/rest_handlers.md
index df5f841..62f0ba1 100644
--- a/guide/rest_handlers.md
+++ b/guide/rest_handlers.md
@@ -12,17 +12,22 @@ REST is implemented in Cowboy as a protocol upgrade. Once upgraded,
the request is handled as a state machine with many optional callbacks
describing the resource and modifying the machine's behavior.
+As the REST handler is still subject to change, the documentation is
+still thin. This state of affair will be improved in the coming weeks.
+
Flow diagram
------------
[email protected] Add the beautiful flow diagram here.
+Not done yet. Feel free to use the one that is currently being worked on.
+
+ * https://github.com/extend/cowboy/pull/364
Callbacks
---------
[email protected] Describe the callbacks.
+Please see the Webmachine documentation at this time.
Usage
-----
[email protected] Explain how to use them.
+Please see the examples at this time.