README.md in interactor-rails-2.0.1 vs README.md in interactor-rails-2.0.2
- old
+ new
@@ -1,12 +1,12 @@
# Interactor Rails
-[![Gem Version](https://badge.fury.io/rb/interactor-rails.png)](http://badge.fury.io/rb/interactor-rails)
-[![Build Status](https://travis-ci.org/collectiveidea/interactor-rails.png?branch=master)](https://travis-ci.org/collectiveidea/interactor-rails)
-[![Code Climate](https://codeclimate.com/github/collectiveidea/interactor-rails.png)](https://codeclimate.com/github/collectiveidea/interactor-rails)
-[![Coverage Status](https://coveralls.io/repos/collectiveidea/interactor-rails/badge.png?branch=master)](https://coveralls.io/r/collectiveidea/interactor-rails?branch=master)
-[![Dependency Status](https://gemnasium.com/collectiveidea/interactor-rails.png)](https://gemnasium.com/collectiveidea/interactor-rails)
+[![Gem Version](https://img.shields.io/gem/v/interactor-rails.svg?style=flat-square)](http://rubygems.org/gems/interactor-rails)
+[![Build Status](https://img.shields.io/travis/collectiveidea/interactor-rails/master.svg?style=flat-square)](https://travis-ci.org/collectiveidea/interactor-rails)
+[![Code Climate](https://img.shields.io/codeclimate/github/collectiveidea/interactor-rails.svg?style=flat-square)](https://codeclimate.com/github/collectiveidea/interactor-rails)
+[![Test Coverage](http://img.shields.io/codeclimate/coverage/github/collectiveidea/interactor-rails.svg?style=flat-square)](https://codeclimate.com/github/collectiveidea/interactor-rails)
+[![Dependency Status](https://img.shields.io/gemnasium/collectiveidea/interactor-rails.svg?style=flat-square)](https://gemnasium.com/collectiveidea/interactor-rails)
Interactor Rails provides Rails support for the
[Interactor](https://github.com/collectiveidea/interactor) gem.
## Installation
@@ -15,11 +15,12 @@
```ruby
gem "interactor-rails", "~> 2.0"
```
-Interactor Rails is compatible with Ruby 1.9 or 2.0 on Rails 3 or 4.
+Interactor Rails is compatible with Ruby 1.9.3, 2.0, 2.1, 2.2, or 2.3 on Rails
+3, 4, or 5.
## Usage
Interactor Rails ensures that `app/interactors` is included in your autoload
paths, and provides generators for your convenience.
@@ -32,11 +33,11 @@
```ruby
class AuthenticateUser
include Interactor
- def perform
+ def call
# TODO
end
end
```
@@ -54,28 +55,18 @@
organize ChargeCard, SendThankYou, FulfillOrder
end
```
-## Contributing
+## Contributions
-Interactor is open source and contributions from the community are encouraged!
-No contribution is too small. Please consider:
+Interactor Rails is open source and contributions from the community are
+encouraged! No contribution is too small.
-* adding an awesome feature
-* fixing a terrible bug
-* updating documentation
-* fixing a not-so-bad bug
-* fixing typos
+See Interactor Rails'
+[contribution guidelines](CONTRIBUTING.md) for more information.
-For the best chance of having your changes merged, please:
-
-1. Ask us! We'd love to hear what you're up to.
-2. Fork the project.
-3. Commit your changes and tests (if applicable (they're applicable)).
-4. Submit a pull request with a thorough explanation and at least one animated GIF.
-
-## Thanks
+## Thank You!
A very special thank you to [Attila Domokos](https://github.com/adomokos) for
his fantastic work on [LightService](https://github.com/adomokos/light-service).
Interactor is inspired heavily by the concepts put to code by Attila.