Update README to include detailed installation instructions

[Jonic]

Currently the README skips straight from "what does it do" to "how to use it". I think that "how to set it up" is a missing step between these two.

While attempting to use this Gem I encountered difficulty actually getting it to work for minitest (it was fine in RSpec), so along with the Gem installation instructions it would be useful to go into more detail about where configuration should live. Is it in an initializer? Does it live in test/test_helper.rb?

It would also be useful to have some information about how to use the Gem in a project which has both minitest and RSpec suites (if that's even possible). I love the idea of the Gem - I'm just struggling to get it to work in our dual-suite application right now!

[EdwardCaulfield]

I am having the same issue. The README says what commands have to be used, but in which file do they go? Initializers? application.rb?

It can't be assumed that everyone reading this knows which files the commands belong in.

[halo]

Additionally, I would like to know whether this needs to go into the main Gemfile group, or whether I can add it to development/test.

[coderberry]

This is still an unanswered question. I'm also unsure how to use this gem. I've been trying to follow the directions, but there's no example, nor instructions on where things go.

[epugh]

So, I'm glad I'm not the only one... Super interested in trying this out... took a stab at adding DeprecationToolkit::Configuration.deprecation_path = 'test/deprecations' to test_helper.rb....

[kvpeab]

I'd also love any tips on the questions asked in this thread! I don't really understand the setup process at all.

[moreno-jordan]

if anyone has a good instruction set on how to set this up properly please let me know

[BrianHicks]

I've added the configuration values inside my RSpec rails_helper.rb. That seems to work OK.

Problem is, then the Rake task doesn't work. 😵