kotovalexarian-likes-github
/
paper-trail-gem--paper_trail
mirror of https://github.com/paper-trail-gem/paper_trail.git
1
0
Fork 0
Code Releases Activity

Update README to clarify version compatibility. Adresses #249 and #250 [ci skip]

This commit is contained in:
Ben Atkins 2013-08-07 10:51:41 -04:00
parent 291aad0e15
commit 4b29959e6e
1 changed files with 23 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -29,9 +29,30 @@ There's an excellent [Railscast on implementing Undo with Paper Trail](http://ra
* Threadsafe.
## Rails Version
## Compatibility
Works on Rails 3 and Rails 2.3. The Rails 3 code is on the `master` branch and tagged `v2.x`. The Rails 2.3 code is on the `rails2` branch and tagged `v1.x`. Please note I'm not adding new features to the Rails 2.3 codebase.
Works with ActiveRecord 4 and ActiveRecord 3. Note: this code is on the `master` branch and tagged `v3.x`.
Version 2 is on the branch named [`2.7-stable`](https://github.com/airblade/paper_trail/tree/2.7-stable) and is tagged `v2.x`, and works with Rails 3.
The Rails 2.3 code is on the [`rails2`](https://github.com/airblade/paper_trail/tree/2.7-stable) branch and tagged `v1.x`. These branches are both stable with their respective versions of Rails but will not have new features added/backported to them.
## Installation
### Rails 3 & 4
1. Install PaperTrail as a gem via your `Gemfile`:
`gem 'paper_trail', '~> 3.0'`
2. Generate a migration which will add a `versions` table to your database.
`bundle exec rails generate paper_trail:install`
3. Run the migration.
`bundle exec rake db:migrate`
4. Add `has_paper_trail` to the models you want to track.
## API Summary
@ -798,29 +819,6 @@ sql> delete from versions where created_at < 2010-06-01;
>> PaperTrail::Version.delete_all ["created_at < ?", 1.week.ago]
```
## Installation
### Rails 3
1. Install PaperTrail as a gem via your `Gemfile`:
`gem 'paper_trail', '~> 2'`
2. Generate a migration which will add a `versions` table to your database.
`bundle exec rails generate paper_trail:install`
3. Run the migration.
`bundle exec rake db:migrate`
4. Add `has_paper_trail` to the models you want to track.
### Rails 2
Please see the `rails2` branch.
## Testing
PaperTrail uses Bundler to manage its dependencies (in development and testing). You can run the tests with `bundle exec rake test`. (You may need to `bundle install` first.)