Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Added yardopts file and instructions on ReadmeDeveloper

  • Loading branch information...
commit f8603a5de319b3457e365d74477becd4f73312e0 1 parent f76badc
Roger Leite authored
Showing with 10 additions and 2 deletions.
  1. +1 −0  .yardopts
  2. +9 −2 ReadmeDeveloper.md
View
1  .yardopts
@@ -0,0 +1 @@
+--plugin yard-tomdoc -r Readme.md - MIT-LICENSE ReadmeDeveloper.md
View
11 ReadmeDeveloper.md
@@ -1,26 +1,33 @@
## Steps to generate doc
```
+# dependencies
$ gem install yard
$ gem install yard-tomdoc
$ gem install redcarpet
-$ yard doc --plugin yard-tomdoc -r Readme.md
-# ignore errors :X
+
+# use params from .yardopts file
+$ yard
$ open doc/index.html
```
+**Obs:** ignore errors :X, until my [pull request](https://github.com/rubyworks/yard-tomdoc/pull/5) be accepted.
## 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
Please sign in to comment.
Something went wrong with that request. Please try again.