From 246861f9fe10be9bbb0f3d56854da47d74b62b2b Mon Sep 17 00:00:00 2001 From: Shane da Silva Date: Tue, 13 Jan 2015 22:35:33 -0800 Subject: [PATCH] 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 Reviewed-by: Shane da Silva --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 6afaff93..097d86c3 100644 --- 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