Created ReadmeDeveloper to contain TODO and Tips

rogerleite · Apr 25, 2012 · f4d89f1 · f4d89f1
1 parent 33a6a0a
commit f4d89f1
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 14 deletions.
diff --git a/ReadmeDeveloper.md b/ReadmeDeveloper.md
@@ -0,0 +1,26 @@
+## Steps to generate doc
+
+```
+$ gem install yard
+$ gem install yard-tomdoc
+$ gem install redcarpet
+$ yard doc --plugin yard-tomdoc -r Readme.md
+# ignore errors :X
+$ open doc/index.html
+```
+
+## TODO:
+
+EntryPoint
+* allow cookies in request
+
+Resource & EntryPoint
+* facilitate cache (Cache Control, ETag, Last-Modified)
+
+HTTP Behaviours
+* improve 404 and 500 errors
+* create librarian-wrappers project
+
+Future Ideas
+* Support to JSON HAL
+* Another project, to Restfolia be a "Restfulie like". Main mission: migrate old projects
diff --git a/TODO b/TODO