README.md in rspec-api-docs-0.3.0 vs README.md in rspec-api-docs-0.4.0

- old
+ new

@@ -40,15 +40,16 @@ ``` The `doc` method stores data in a hash on the RSpec example metadata. The second stage is the formatter (`RspecApiDocs::Formatter`). The formatter -parses the hash stored on each RSpec example and uses a renderer -(lib/rspec_api_docs/formatter/renderer/) to write out your documentation. +parses the hash stored on each RSpec example and uses a +[renderer](lib/rspec_api_docs/formatter/renderer/README.md) to write out your +documentation. ``` -bundle exec rspec spec/requests/characters_spec.rb --formatter=RspecApiDocs::Formatter +$ rspec spec/requests/characters_spec.rb --formatter=RspecApiDocs::Formatter ``` ### DSL First, require the DSL and include the DSL module. @@ -244,10 +245,10 @@ git commits and tags, and push the `.gem` file to [rubygems.org]. Regenerate this project's integration spec docs locally: ``` -./bin/generate_integration_docs +$ ./bin/generate_integration_docs ``` ## TODO - Allow specifying an order (`precedence`?)