From 1d8e1b3bef90cbe46dba31b9ca331bb6134826b8 Mon Sep 17 00:00:00 2001 From: Jon Atack Date: Sat, 28 Mar 2015 16:12:23 +0530 Subject: [PATCH] [skip ci] More docs updates --- CHANGELOG.md | 9 +++++---- README.md | 10 +++------- 2 files changed, 8 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f89f06a..d191f9b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,8 +5,8 @@ * [WIP/experimental] Add compatibility with Rails 5/master and Arel 7. -* Update the Contributing Guide with detailed steps for contributing to - Ransack. +* Update the [Contributing Guide](CONTRIBUTING.md) with detailed steps for + contributing to Ransack. * Broaden the test suite database options in `schema.rb` and add code documentation. @@ -27,10 +27,11 @@ ### Fixed -* Stop relying on Active Record::relation#where_values which are deprecated +* Stop relying on `Active Record::relation#where_values` which are deprecated in Rails 5. -* Make the ransacker_args test work correctly with Sqlite3. +* Make the test for passing search arguments to a ransacker + (`ransacker_args`) work correctly with Sqlite3. *Jon Atack* diff --git a/README.md b/README.md index 75368c9..d1c0f5a 100644 --- a/README.md +++ b/README.md @@ -33,17 +33,13 @@ 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.1) on Ruby 1.9 and -later. - -It currently works with Rails 5/master too -- although changes in Arel and -Active Record keep that a moving target. +later. It currently works with Rails 5 as well, though changes in Arel and +Active Record keep that a moving target. If you are using Ruby 1.8, you can use +an earlier version of Ransack up to v1.3.0. 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: ```ruby