README.md in rspec-api-docs-0.5.0 vs README.md in rspec-api-docs-0.6.0
- old
+ new
@@ -6,10 +6,19 @@
<a href="https://travis-ci.org/twe4ked/rspec-api-docs"><img src="https://img.shields.io/travis/twe4ked/rspec-api-docs.svg?style=flat-square" /></a>
<a href="https://rubygems.org/gems/rspec-api-docs"><img src="https://img.shields.io/gem/v/rspec-api-docs.svg?style=flat-square" /></a>
<a href="http://www.rubydoc.info/github/twe4ked/rspec-api-docs/master"><img src="https://img.shields.io/badge/docs-master-lightgrey.svg?style=flat-square" /></a>
</p>
+**rspec-api-docs** provides a way to generate documentation from your request
+specs. It does this by providing a simple DSL and a custom formatter.
+
+The default renderer produces a [single JSON file] which can be used by
+[api-docs] to [display your documentation].
+
+[single JSON file]: ./spec/integration/output/json/index.json
+[display your documentation]: https://twe4ked.github.io/api-docs/
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -263,10 +272,11 @@
```
## TODO
- Allow specifying an order (`precedence`?)
+- Order Resources and Examples alphabetically
## Contributing
Bug reports and pull requests are welcome on GitHub at
https://github.com/twe4ked/rspec-api-docs. This project is intended to be a
@@ -279,5 +289,6 @@
The gem is available as open source under the terms of the [MIT License].
[MIT License]: http://opensource.org/licenses/MIT
[Contributor Covenant]: http://contributor-covenant.org
[rubygems.org]: https://rubygems.org
+[api-docs]: https://github.com/twe4ked/api-docs