README.md in statesman-events-0.0.1 vs README.md in statesman-events-1.0.0

- old
+ new

@@ -1,7 +1,22 @@ +# Statesman Events (UNMAINTAINED) + Event support for [Statesman](https://github.com/gocardless/statesman). +[![Gem Version](https://badge.fury.io/rb/statesman-events.png)](http://badge.fury.io/rb/statesman-events) +[![Build Status](https://travis-ci.org/gocardless/statesman-events.svg?branch=master)](https://travis-ci.org/gocardless/statesman-events) + + +# THIS REPO IS UNMAINTAINED. PLEASE DO NOT USE IT. +--- + +## Installation + +```ruby +gem install statesman-events +``` + ## TL;DR Usage ```ruby class TaskStateMachine include Statesman::Machine @@ -68,19 +83,17 @@ Triggers the passed event, returning `true` on success. Returns false on failure. #### `Event#trigger!` ```ruby -instance.trigger(:some_event) +instance.trigger!(:some_event) ``` Triggers the passed event, returning `true` on success. Raises -`Statesman::GuardFailedError` or `Statesman::TransitionFailedError` on failure. +`Statesman::GuardFailedError` or `Statesman::InvalidTransitionError` on failure. #### `Event#available_events` ```ruby instance.available_events ``` Returns an array of events you can `trigger` from the current state. --- - -GoCardless ♥ open source. If you do too, come [join us](https://gocardless.com/jobs#software-engineer).