README.md in drg-0.5.0 vs README.md in drg-0.5.1
- old
+ new
@@ -8,16 +8,34 @@
```ruby
gem 'drg'
```
-## Usage
+## Tasks
-### Pinning Gems
+```bash
+rake drg:update
+rake drg:pin
+rake drg:pin:minor
+rake drg:pin:major
+rake drg:unpin
+```
+### drg:update
+
+DRG can update your outdated gems, one-by-one, to the latest version. It'll update the gem and then run your tests.
+If your tests pass, then the new version will be written to your Gemfile (similar to Gemnasium).
+
+```bash
+rake drg:update
+```
+
+### pin
+
DRG really wants to help you manage your project's gems. But DRG doesn't want to replace Bundler. Instead we want to build on
-it. You can "pin" all your versions to the current version listed in the Gemfile.lock:
+it. Pinning ignores gems that are fetched from somewhere other than rubygems. For example, gems listed with `:git`, `:github`,
+or `:path` will be ignored. You can "pin" all your versions to the current version listed in the Gemfile.lock:
```bash
rake drg:pin
```
@@ -25,33 +43,31 @@
```ruby
gem 'rails'
gem 'byebug', require: false
gem 'therubyracer', '~> 0.12', platforms: :ruby
-
-# gotta include ourselves
gem 'drg'
```
it'll get changed to
```ruby
gem 'rails', '4.2.3'
gem 'byebug', '5.0.0', require: false
gem 'therubyracer', '0.12.2', platforms: :ruby
-
-# gotta include ourselves
gem 'drg', '0.4.1'
```
+### pin:minor
+
Although, you may want to pin gems with their _minor_ version (which allows updating patches). Run:
```bash
rake drg:pin:minor
```
-This will change a gem listed like
+Which will update your Gemfile from
```ruby
gem 'rails', '4.2.3'
```
@@ -59,23 +75,25 @@
```ruby
gem 'rails', '~> 4.2'
```
-Pinning ignores gems that are fetched from somewhere other than rubygems. For example, gems listed with `:git`, `:github`,
-or `:path` will be ignored.
+This can be combined with `bundle update` to quickly update all gems to the latest patch or minor level.
-There is also a `rake drg:pin:major` which does what you think.
+### pin:major
-This can be combined with `bundle update` to quickly update all gems to the latest patch or minor level.
+There is also a
-### Updating Gems
+ ```bash
+ rake drg:pin:major
+ ```
-DRG can also try to update all outdated gems to the most recent version. It'll update the gem and run your tests. If your
-tests pass, then it'll update your gemfile with the current version. Similar to what Gemnasium offers (experience may vary).
+### drg:unpin
+Remove the versions from your Gemfile. Start fresh!
+
```bash
-rake drg:update
+rake drg:unpin
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests.