== RELEASE:

This has not been used in a production app yet.
It is alpha software.

== DESCRIPTION:

recommendable is a Ruby gem which adds simple 
item-to-item collaborative filtering to 
ActiveRecord-based apps.

It creates a Similar#{ModelName} model and migration for
the associated similar_#{model_name}s table with the following columns:

  id
  #{model_name}_one
  #{model_name}_two
  score

It creates a rake task that updates the similar table, 
which is time-intensive and should be run via cron at
off-peak hours for your Rails app.

== USAGE:

cd RAILS_ROOT
./script/generate recommendable RECOMMENDABLEMODEL

== REQUIREMENTS:

* ActiveRecord

(The MIT License)

Copyright (c) 2008 Dan Croak, Josh Nichols, Jason Morrison, and
the Boston.rb group.

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.