Add Documentation section to README

Make it more obvious that we have code documentation easily accessible online. Change-Id: Iafe79c8e7a5edfce43c317148736118ea4591b8c Reviewed-on: http://gerrit.causes.com/45709 Tested-by: jenkins <[email protected]> Reviewed-by: Shane da Silva <[email protected]>
rayrog · Jan 14, 2015 · 246861f · 246861f
1 parent 6035927
commit 246861f
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -23,6 +23,7 @@ established by the team at [Causes.com](https://causes.com).
 * [Editor Integration](#editor-integration)
 * [Git Integration](#git-integration)
 * [Rake Integration](#rake-integration)
+* [Documentation](#documentation)
 * [Contributing](#contributing)
 * [Changelog](#changelog)
 * [License](#license)
@@ -176,6 +177,14 @@ rake 'haml_lint[app/views, custom/*.haml]'
 Files specified in this manner take precedence over the task's `files`
 attribute.
 
+## Documentation
+
+[Code documentation] is generated with [YARD] and hosted by [RubyDoc.info].
+
+[Code documentation]: http://rdoc.info/github/causes/haml-lint/master/frames
+[YARD]: http://yardoc.org/
+[RubyDoc.info]: http://rdoc.info/
+
 ## Contributing
 
 We love getting feedback with or without pull requests. If you do add a new