Permalink
Browse files

Update CHANGELOG.md

  • Loading branch information...
1 parent 5bdadeb commit 0f6d5d1180843e074a985f0c6298a38dcf8c6f37 David Celis committed Nov 6, 2012
Showing with 26 additions and 1 deletion.
  1. +26 −1 CHANGELOG.md
View
@@ -84,7 +84,32 @@ end
* Renamed the concept of Ignoring to Hiding
* Renamed the concept of Stashing to Bookmarking
* Likes, Dislikes, Hidden Items, and Bookmarked items are no longer stored as models. They are, instead, permanently stored in Redis.
-* Added a Configuration class
+* Added a Configuration class. Recommendable is now configured as such:
+
+```ruby
+require 'redis'
+
+Recommendable.configure do |config|
+ # Recommendable's connection to Redis
+ config.redis = Redis.new(:host => 'localhost', :port => 6379, :db => 0)
+
+ # A prefix for all keys Recommendable uses
+ config.redis_namespace = :recommendable
+
+ # Whether or not to automatically enqueue users to have their recommendations
+ # refreshed after they like/dislike an item
+ config.auto_enqueue = true
+
+ # The name of the queue that background jobs will be placed in
+ config.queue_name = :recommendable
+
+ # The number of nearest neighbors (k-NN) to check when updating
+ # recommendations for a user. Set to `nil` if you want to check all
+ # other users as opposed to a subset of the nearest ones.
+ config.nearest_neighbors = nil
+end
+```
+
* Enable Ruby 1.8.7 support
1.1.7 (Current version)

0 comments on commit 0f6d5d1

Please sign in to comment.