Add YARD development dependency and usage notes

myronmarston · Dec 15, 2011 · 54b5829 · 54b5829
1 parent c600695
commit 54b5829
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -119,6 +119,12 @@ VCR has been tested on the following ruby interpreters:
   and create a topic branch for every separate change you make.
 * See the [Contributing](https://github.com/myronmarston/vcr/blob/master/CONTRIBUTING.md)
   guide for instructions on running the specs and features.
+* Documentation is generated with [YARD](http://yardoc.org/) ([cheat sheet](http://cheat.errtheblog.com/s/yard/)).
+  To generate while developing:
+
+```
+yard server --reload
+```
 
 If you find VCR useful, please recommend me on [working with rails](http://workingwithrails.com/person/16590-myron-marston).
 

diff --git a/vcr.gemspec b/vcr.gemspec
@@ -39,6 +39,7 @@ Gem::Specification.new do |s|
     'rack'            => '1.1.0',
     'sinatra'         => '~> 1.1.0',
 
+    'yard'            => '~> 0.7.4',
     'multi_json'      => '~> 1.0.3'
   }.each do |lib, version|
     s.add_development_dependency lib, version