# rspec-api-docs ## Installation Add this line to your application's Gemfile: ```ruby gem 'rspec-api-docs' ``` And then execute: $ bundle Or install it yourself as: $ gem install rspec-api-docs ## Usage For now see the integration specs. ``` rm -rf spec/integration/output rspec spec/integration/rspec_api_docs_spec.rb --format=RspecApiDocs::Formatter ``` ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org]. ## 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 safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant] code of conduct. ## License 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