kotovalexarian-likes-github
/
activerecord-hackery--ransack
mirror of https://github.com/activerecord-hackery/ransack.git
1
0
Fork 0
Code Releases Activity

Update README for Rails 4.1 and add a missing period.

This commit is contained in:
jonatack 2013-12-18 20:17:06 +01:00
parent add49ea4f4
commit 3e5402848a
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -17,21 +17,23 @@ for Ransack (or MetaSearch, for that matter). Try
In your Gemfile:
```ruby
gem "ransack" # Last officially released gem (Rails 3 and 4)
gem "ransack" # Last officially released gem (Rails 3.x and 4.0)
```
Or if you want to use the bleeding edge (Rails 3 and 4):
Or if you want to use the bleeding edge (Rails 3.x and 4.0):
```ruby
gem "ransack", github: "activerecord-hackery/ransack" # Track git repo
```
A lighter, faster, latest-commits version of Ransack dedicated to Rails 4 is available on the "rails-4" branch:
A lighter, faster, latest-commits version of Ransack dedicated to Rails 4.0 is available on the "rails-4" branch:
```ruby
gem "ransack", github: "activerecord-hackery/ransack", branch: "rails-4"
```
Ransack is not yet compatible with Rails 4.1, due to changes and refactoring in ActiveRecord that breaks the [Polyamorous](https://github.com/activerecord-hackery/polyamorous) gem that Ransack depends upon. Feel free to contribute a PR to fix it!
## Usage
Ransack can be used in one of two modes, simple or advanced.
@ -47,7 +49,7 @@ If you're coming from MetaSearch, things to note:
primarily to shorten query strings, though advanced queries (below) will still
run afoul of URL length limits in most browsers and require a switch to HTTP
POST requests. This key is
[configurable](https://github.com/activerecord-hackery/ransack/wiki/Configuration)
[configurable](https://github.com/activerecord-hackery/ransack/wiki/Configuration).
2. `form_for` is now `search_form_for`, and validates that a Ransack::Search object
is passed to it.
3. Common ActiveRecord::Relation methods are no longer delegated by the search object.