Skip to content

Commit

Permalink
Bump version for 0.1.5 and update the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
drewish committed May 6, 2018
1 parent 56a2280 commit b019d25
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
[![Code Climate](https://codeclimate.com/github/drewish/rspec-rails-swagger/badges/gpa.svg)](https://codeclimate.com/github/drewish/rspec-rails-swagger)

This gem helps you generate Swagger docs by using RSpec to document the paths.
You execute a command to run the tests and generate the `.json` output. Running
the tests ensures that your API and docs are in agreement, and generates output
that can be used as examples.
You execute a command to run the tests and generate the `.yaml` or `.json` output.
Running the tests ensures that your API and docs are in agreement, and generates
output that can be saved as response examples.

The design of this was heavily influenced by the awesome [swagger_rails gem](https://github.com/domaindrivendev/swagger_rails).

Expand Down Expand Up @@ -52,9 +52,9 @@ and some default requests filled in. With the structure in place you should only
need to add `before` calls to create records and then update the `let`s to
return the appropriate values.

## Generate the JSON
## Generate the JSON or YAML

To create the Swagger JSON files use the rake task:
To create the Swagger files use the rake task:

```
bundle exec rake swagger
Expand Down
2 changes: 1 addition & 1 deletion lib/rspec/rails/swagger/version.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module Rails
# Version information for RSpec Swagger.
module Swagger
module Version
STRING = '0.1.4'
STRING = '0.1.5'
end
end
end
Expand Down

0 comments on commit b019d25

Please sign in to comment.