Skip to content

Commit 91bb0be

Browse files
authored
docs: add installation instructions and gem version (#16)
1 parent 7d3aab3 commit 91bb0be

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,39 @@
11
# GraphitiSpecHelpers
22

33
![Build Status](https://travis-ci.org/graphiti-api/graphiti_spec_helpers.svg?branch=master)
4+
[![Gem Version](https://badge.fury.io/rb/graphiti_spec_helpers.svg)](https://badge.fury.io/rb/graphiti_spec_helpers)
45

56
Spec helpers for [Graphiti](https://github.com/graphiti-api/graphiti)
67
APIs.
8+
9+
# Installation
10+
Note: this assumes you have [rspec-rails](https://github.com/rspec/rspec-rails) installed & configured already.
11+
12+
`Gemfile`
13+
```ruby
14+
group :development, :test do
15+
# ...
16+
gem 'graphiti_spec_helpers', '~> 1.1'
17+
# ...
18+
end
19+
```
20+
21+
`spec/rails_helper.rb`
22+
```ruby
23+
# ...
24+
# Add additional requires below this line. Rails is not loaded until this point!
25+
require 'graphiti_spec_helpers/rspec'
26+
# ...
27+
28+
RSpec.configure do |config|
29+
# ...
30+
config.include GraphitiSpecHelpers::RSpec
31+
config.include GraphitiSpecHelpers::Sugar
32+
config.include Graphiti::Rails::TestHelpers
33+
# ...
34+
```
35+
36+
Then in your project directory
37+
```sh
38+
$ bundle install
39+
```

0 commit comments

Comments
 (0)