README

   1 acts_as_ferret
   2
   3 This ActiveRecord mixin adds full text search capabilities to any Rails model.
   4
   5 It is heavily based on the original acts_as_ferret plugin done by
   6 Kasper Weibel and a modified version done by Thomas Lockney, which
   7 both can be found on http://ferret.davebalmain.com/trac/wiki/FerretOnRails
   8
   9 usage:
  10 include the following in your model class (specifiying the fields you want to get indexed):
  11
  12 acts_as_ferret :fields => [ 'title', 'description' ]
  13
  14 now you can use ModelClass.find_by_contents(query) to find instances of your model
  15 whose indexed fields match a given query. All query terms are required by default,
  16 but explicit OR queries are possible. This differs from the ferret default, but
  17 imho is the more often needed/expected behaviour (more query terms result in
  18 less results).
  19
  20 Released under the MIT license.
  21
  22 Authors:
  23 Kasper Weibel Nielsen-Refs (original author)
  24 Jens Kraemer <jk@jkraemer.net>
  25
  26