Skip to content

Commit

Permalink
Add 'Getting started' section to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
mcmire committed Jan 26, 2023
1 parent 5828591 commit 52915f3
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,25 @@ fully compatible with your existing tests and requires no retooling to use.
[shoulda-matchers]: https://github.com/thoughtbot/shoulda-matchers
[minitest_matchers-vaccine]: https://github.com/rmm5t/minitest-matchers_vaccine

## Getting started

If you're working on a Rails app, then make sure to add this gem to the `test`
group in your Gemfile:

``` ruby
group :test do
gem 'shoulda-context', '~> 2.0'
end
```

If you're not working on a Rails app, then you can simply add:

``` ruby
gem 'shoulda-context', '~> 2.0'
```

Then run `bundle install`.

## Overview

Instead of writing Ruby methods with `lots_of_underscores`, Shoulda Context lets
Expand Down

0 comments on commit 52915f3

Please sign in to comment.