README.md in cap-util-1.1.0 vs README.md in cap-util-1.2.0
- old
+ new
@@ -1,26 +1,12 @@
# CapUtil
A set of utilities for writing cap tasks. Use these to help extract business logic from your tasks and test them.
-## Installation
-
-Add this line to your application's Gemfile:
-
- gem 'cap-util'
-
-And then execute:
-
- $ bundle
-
-Or install it yourself as:
-
- $ gem install cap-util
-
## The Mixin
-The main `CapUtil` mixin can be used to make any class a cap utility. All the cap util requires is that your class define a `cap` method that returns an instance of a cap invocations.
+The main `CapUtil` mixin can be used to make any class a cap utility. All the cap util requires is that your class define a `cap` method that returns an instance of a cap invocations. The mixin provides a default `attr_accessor :cap` for you; set an `@cap` instance variable to use it or override it with a custom `def cap` method.
```ruby
# in some_great_util.rb
require 'cap-util'
@@ -163,9 +149,23 @@
File.read(@roles_file_path)
end
end
```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+ gem 'cap-util'
+
+And then execute:
+
+ $ bundle
+
+Or install it yourself as:
+
+ $ gem install cap-util
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)