Skip to content

Commit

Permalink
More docs
Browse files Browse the repository at this point in the history
  • Loading branch information
drewish committed Sep 26, 2016
1 parent c43e589 commit c6b2d18
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,18 @@ The design of this was heavily influenced by the awesome [swagger_rails gem](htt
## Setup

- Add the gem to your Rails app's `Gemfile`:
```
```rb
group :development, :test do
gem 'rspec-swagger'
end
```
- If you don't already have a `spec/rails_helper.rb` file run:
```
```shell
rails generate rspec:install
```
- Create `spec/swagger_helper.rb` file (eventually this will become a generator):
```
- Create `spec/swagger_helper.rb` file (eventually [this will become a
generator](https://github.com/drewish/rspec-swagger/issues/3)):
```rb
require 'rspec/swagger'
require 'rails_helper'

Expand Down Expand Up @@ -54,21 +55,21 @@ end

## Generate the docs

Eventually this will become a rake task:
Eventually [this will become a rake task](https://github.com/drewish/rspec-swagger/issues/2):
```
bundle exec rspec -f RSpec::Swagger::Formatter --order defined -t swagger_object
```

## Running tests

The `make_site.sh` script will create a test site for a specific version of
Rails:
Rails and run the tests:
```
RAILS_VERSION=4.2.0
./make_site.sh
```

Re-run the tests:
Once the test site is created you can just re-run the tests:
```
bundle exec rspec
```

0 comments on commit c6b2d18

Please sign in to comment.