Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README and clarify wording #444

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README and clarify wording #444

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ protection.
To get started, just add Statesman to your `Gemfile`, and then run `bundle`:

```ruby
gem 'statesman', '~> 8.0.3'
gem 'statesman', '~> 9.0.0'
```

## Usage
Expand Down Expand Up @@ -184,11 +184,13 @@ or 5. To do that
```

* Remove the `include Statesman::Adapters::ActiveRecordTransition` statement from
your transition model. (If you want to customise your transition class's "updated
timestamp column", as described above, you should define a
`.updated_timestamp_column` method on your class and return the name of the column
as a symbol, or `nil` if you don't want to record an updated timestamp on
transitions.)
your transition model, which would've instructed ActiveRecord to serialize the
metadata.
* The module that you just removed enables customizing the updatated timestamp column
as described above. Having removed it, if you want to customise your transition class's
"updated timestamp column", you should define a `.updated_timestamp_column` method on
your class and return the name of the column as a symbol, or `nil` if you don't want
to record an updated timestamp on transitions.

## Configuration

Expand Down Expand Up @@ -425,8 +427,8 @@ model and passing in `transition_class` and `initial_state` as options.

In 4.1.2 and below, these two options had to be defined as methods on the model,
but 5.0.0 and above allow this style of configuration as well.
The old method pollutes the model with extra class methods, and is deprecated,
to be removed in 6.0.0.
The old way pollutes the model with extra class methods, and is deprecated,
to be removed in the future.

```ruby
class Order < ActiveRecord::Base
Expand Down