1
0
Fork 0
mirror of https://github.com/activerecord-hackery/ransack.git synced 2022-11-09 13:47:45 -05:00

[skip ci] Update README: Rails 4.2.1 and 5.0.0

This commit is contained in:
jonatack 2015-03-22 22:27:17 +05:30
parent 9e818cde53
commit ccf47e286d

View file

@ -32,12 +32,17 @@ you're reading the documentation for the master branch with the latest features.
## Getting started
Ransack is compatible with Rails 3 and 4 (including 4.2) on Ruby 1.9 and later.
We try to keep it functioning with Rails master too, although frequent changes
in Arel and Active Record make that a moving target. Ransack works
out-of-the-box with Active Record and features new support for Mongoid 4.0
(without associations, further details below). If you are on Ruby 1.8, you may
need to use an earlier version of Ransack like 1.3.0.
Ransack is compatible with Rails 3 and 4 (including 4.2.1) on Ruby 1.9 and
later.
It currently works with Rails 5.0.0/master too! Although changes in Arel
and Active Record keep that a moving target.
Ransack works out-of-the-box with Active Record and also features experimental
support for Mongoid 4.0 (without associations, further details below).
If you are using Ruby 1.8, you may need to use an earlier version of Ransack,
like 1.3.0.
In your Gemfile, for the last officially released Ransack gem:
@ -65,15 +70,6 @@ To use one of the branches, for example the `rails-4.1` branch:
gem 'ransack', github: 'activerecord-hackery/ransack', branch: 'rails-4.1'
```
If you are using Rails master, be advised that Ransack master does not yet work
with the breaking changes in Rails master and Arel master added since December
2014. The most recent working commits are:
```ruby
gem 'rails', github: 'rails/rails', ref: '266ff70'
gem 'arel', github: 'rails/arel', ref: '008445d'
```
## Usage
Ransack can be used in one of two modes, simple or advanced.