README.md in action_logic-0.2.6 vs README.md in action_logic-0.2.7
- old
+ new
@@ -1,11 +1,12 @@
# ActionLogic
-[![Codeship Status for rewinfrey/action_logic](https://codeship.com/projects/7737cf40-6808-0133-84a7-460d97cd31f0/status?branch=master)](https://codeship.com/projects/114179)
+[![Build Status](https://travis-ci.org/rewinfrey/ActionLogic.svg?branch=master)](https://travis-ci.org/rewinfrey/ActionLogic)
[![Gem Version](https://badge.fury.io/rb/action_logic.svg)](https://badge.fury.io/rb/action_logic)
[![Code Climate](https://codeclimate.com/github/rewinfrey/action_logic/badges/gpa.svg)](https://codeclimate.com/github/rewinfrey/action_logic)
-[![Coverage Status](https://coveralls.io/repos/rewinfrey/action_logic/badge.svg?branch=master&service=github)](https://coveralls.io/github/rewinfrey/action_logic?branch=master)
+[![coverage](https://codecov.io/github/rewinfrey/ActionLogic/coverage.svg?branch=master)](https://codecov.io/github/rewinfrey/ActionLogic?branch=master)
+[![Dependency Status](https://gemnasium.com/rewinfrey/action_logic.svg)](https://gemnasium.com/rewinfrey/action_logic)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
### Introduction
This is a business logic abstraction gem that provides structure to the organization and composition of business logic in a Ruby or Rails application. `ActionLogic` is inspired by gems like [ActiveInteraction](https://github.com/orgsync/active_interaction), [DecentExposure](https://github.com/hashrocket/decent_exposure), [Interactor](https://github.com/collectiveidea/interactor), [Light-Service](https://github.com/adomokos/light-service), [Mutations](https://github.com/cypriss/mutations), [Surrounded](https://github.com/saturnflyer/surrounded), [Trailblazer](https://github.com/apotonick/trailblazer) and [Wisper](https://github.com/krisleech/wisper).
@@ -36,10 +37,12 @@
* [Benchmarking](#benchmarking)
* [Enable Benchmarking](#enable-benchmarking)
* [Benchmark Logging](#benchmark-logging)
* [Benchmark Log Formatting](#benchmark-log-formatting)
* [Custom Benchmark Handling](#custom-benchmark-handling)
+* [Installation](#installation)
+* [Contributing](#contributing)
### Backstory
Consider a traditional e-commerce Rails application. Users can shop online and add items to their shopping cart until they are ready to check out.
The happy path scenario might go something like this: the user submits their order form, an orders controller action records the order in the database,
@@ -1046,5 +1049,20 @@
config.benchmark = true
config.benchmark_log = File.open("benchmark.log", "w")
config.benchmark_handler = CustomHandler.new
end
```
+
+### Installation
+
+Add `ActionLogic` to your project's Gemfile:
+
+`gem 'action_logic'`
+
+Don't forget to bundle:
+
+`$ bundle`
+
+### Contributing
+
+Interested in contributing to `ActionLogic`? If so that is awesome! <3
+Please see the [contributing doc](https://github.com/rewinfrey/ActionLogic/blob/master/CONTRIBUTING.md) for details.