README.md in test_diff-0.3.4 vs README.md in test_diff-0.4.0
- old
+ new
@@ -1,37 +1,56 @@
# TestDiff
[![Build Status](https://travis-ci.org/grantspeelman/test_diff.svg?branch=master)](https://travis-ci.org/grantspeelman/test_diff)
-Gem that attempts to find the tests that are required to run for the changes you have made
+Gem that attempts to find the tests that are required to run for the changes you have made.
+## Project requirements
+
+* RSpec 2+
+* project tracked with git
+
## Installation
Add this line to your application's Gemfile:
```ruby
-gem 'test_diff'
+gem 'test_diff', group: :test
```
And then execute:
$ bundle
-Or install it yourself as:
+## Rails Setup
- $ gem install test_diff
+Suggest to disabled `eager_load` in `config/environments/test.rb` based on `ENV['TEST_DIFF_COVERAGE']`
+EG:
+```ruby
+config.eager_load = ENV['TEST_DIFF_COVERAGE'].blank?
+```
+
+Also make sure to disable `simple_cov` if you use it when `ENV['TEST_DIFF_COVERAGE']` is set
+EG:
+
+```ruby
+unless ENV['TEST_DIFF_COVERAGE']
+ require 'simplecov'
+ SimpleCov.start 'rails'
+end
+```
+
## Usage
Building the test coverage index
- $ bundle exec test_diff build_coverage spec spec/spec_helper.rb
- $ bundle exec test_diff track_build
- $ git add test_diff_coverage
- $ git commit
+ $ test_diff build_coverage spec spec/spec_helper.rb
+ $ # part here to upload test_diff_coverage to a shared space, ie aws
Running a test difference
- $ bundle exec test_diff run_spec_diff
+ $ # part here to download test_diff_coverage from shared space, ie aws
+ $ test_diff rspec
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.