README.md in link-checker-0.2.0 vs README.md in link-checker-0.3.0

- old
+ new

@@ -12,11 +12,11 @@ Then ```bundle install``` to install the gem. ## Usage -You can use the ```check-links``` command to specify any directory to scan for HTML files. +You can use the ```check-links [PATH]``` command to specify any directory to scan for HTML files. The default path is ```./```. For example, to check the links for an Octopress site: check-links 'public' @@ -28,6 +28,10 @@ The ```link-checker``` gem uses [RSpec](http://rspec.info) for testing and has 100% test coverage, verified using [simplecov](https://github.com/colszowka/simplecov). Run the specs with: - rake spec + rake spec + +## API Documentation + +The Yardoc documenation is hosted on [RubyDoc.info](http://rubydoc.info/github/endymion/link-checker/frames). \ No newline at end of file