README.md in gem_bench-1.0.2 vs README.md in gem_bench-1.0.3
- old
+ new
@@ -1,9 +1,11 @@
# GemBench [![Inline docs](http://inch-ci.org/github/pboling/gem_bench.png)](http://inch-ci.org/github/pboling/gem_bench)
-`gem_bench` is the super easy way to trim down app load times by keeping your worst players on the bench.
+`gem_bench` is for static Gemfile and installed gem library source code analysis.
+`gem_bench` can also be used to trim down app load times by keeping your worst players on the bench.
+
Gem: "Put me in coach!"
You: ❨╯°□°❩╯︵┻━┻
Version constraints are important. Give the Gemfile some love in your CI build - New for 1.0.2
@@ -72,26 +74,30 @@
Just install it, and require it in your`irb`/`console` session when you want to use it. However, if you load your console with `bundle exec` then you only have access to gems in the gemfile, so either load without `bundle exec` or add it to the `Gemfile`.
$ gem install gem_bench
-
### Option 2
If you decide to include it in your project: add this line to your `Gemfile` in the `:development` group.
gem 'gem_bench', :require => false, :group => :development
-### Option BEST
+### Option BEST 1
Or better yet [follow the bundle group pattern in your Gemfile][bundle-group-pattern] and setup a console group so it will only load in the console, and not the web app. With it loading only in the console session the `require: false` is completely optional. The gem is tiny, so won't impact console load time much. Requiring it will allow checking your `Gemfile` without needing to first `require 'gem_bench'`.
gem 'gem_bench', :group => :console
And then execute:
$ bundle
+### Option BEST 2
+
+If you are going to use the gem in your specs, you will need to add it to the test group.
+
+ gem 'gem_bench', :group => :test
## Usage
Works with Ruby >= 2.0 due to use of named parameters.