Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

updated readme

  • Loading branch information...
commit 00c82edf4e755fffc964542874df898a5e8b554d 1 parent e85cd1b
@cmer authored
Showing with 8 additions and 0 deletions.
  1. +8 −0 README.md
View
8 README.md
@@ -202,6 +202,14 @@ All mentioners
***
+## Documentation
+
+You can find the compiled YARD documentation at http://rubydoc.info/github/cmer/socialization/frames. Documentation for methods inside `include` blocks is not currently generated although it exists in the code. A custom YARD filter needs to be written for YARD to pick those up.
+
+
+***
+
+
## Demo App
For your convenience, I have added a demo app in demo/demo_app. It does not have a web UI, but you can play with Socialization in the Rails console. It should also help you figure out hown to use Socialization in the Real World.
Please sign in to comment.
Something went wrong with that request. Please try again.