Skip to content

Commit 5e6127c

Browse files
authored
Merge pull request #38 from drewish/release-0.1.5
Bump version for 0.1.5 and update the readme
2 parents 56a2280 + b019d25 commit 5e6127c

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
[![Code Climate](https://codeclimate.com/github/drewish/rspec-rails-swagger/badges/gpa.svg)](https://codeclimate.com/github/drewish/rspec-rails-swagger)
55

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

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

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

55-
## Generate the JSON
55+
## Generate the JSON or YAML
5656

57-
To create the Swagger JSON files use the rake task:
57+
To create the Swagger files use the rake task:
5858

5959
```
6060
bundle exec rake swagger

lib/rspec/rails/swagger/version.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ module Rails
33
# Version information for RSpec Swagger.
44
module Swagger
55
module Version
6-
STRING = '0.1.4'
6+
STRING = '0.1.5'
77
end
88
end
99
end

0 commit comments

Comments
 (0)