|author||Loïc Hoguin <[email protected]>||2013-02-11 09:26:13 +0100|
|committer||Loïc Hoguin <[email protected]>||2013-02-11 09:26:13 +0100|
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')
1 files changed, 8 insertions, 3 deletions
diff --git a/guide/rest_handlers.md b/guide/rest_handlers.md
index df5f841..62f0ba1 100644
@@ -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.
-@todo 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
-@todo Describe the callbacks.
+Please see the Webmachine documentation at this time.
-@todo Explain how to use them.
+Please see the examples at this time.