README.md in fitting-0.4.2 vs README.md in fitting-1.0.0

- old
+ new

@@ -22,39 +22,16 @@ $ gem install fitting ## Usage -### rspec-rails +In your `spec_helper.rb`: -rails_helper.rb - ```ruby -require 'fitting' -config.after(:each, :type => :controller) do - Fitting::Documentation.try_on(self, request, response) -end +config.include JSON::SchemaMatchers ``` -### Formatting - -``` -bundle exec rspec --format Fitting::Formatter::Response::MacroYaml -``` - -or - -``` -bundle exec rspec --format Fitting::Formatter::Response::MicroYaml -``` - -After that you can find the report in `report_response_macro.yaml` or `report_response_micro.yaml`. - -## Config - -### tomogram - This gem takes a simplified format json convert from API Blueprint which we have called API Tomogram. Use gem [tomograph](https://github.com/funbox/tomograph) ```ruby @@ -62,20 +39,26 @@ config.tomogram = 'tomogram.json' end ``` -### skip_not_documented +You can then write tests such as: -Default true. +```ruby + expect(response).to match_response +``` -### validation_requests +If you want check all tests: -Default true. +```ruby +config.after(:each, :type => :controller) do + expect(response).to match_response +end +``` -### validation_response +## Report -Default true. +Autogenerate `report_request_by_response.yaml` and `report_response.yaml reports`. ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/funbox/fitting. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.