From 5b97e7132d5a0faae24b8c929aea281e7a0d25eb Mon Sep 17 00:00:00 2001 From: Jeff Dutil Date: Thu, 7 Feb 2013 19:15:17 -0500 Subject: [PATCH] Update README with requirements. [Fixes #8] --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index c00f05f..90eaf46 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,28 @@ _Recommendify is a ruby/redis based recommendation engine_ - The recommendation + __"Users that viewed this video also viewed..."__ from `user_id--viewed-->video_id` pairs + __"Users that like this venue also like..."__ from `user_id--likes-->venue_id` pairs +Requirements +------------ + +Installing the recommendify gem will fail if your system does not have the hiredis library. + +To install on OSX run: + +```shell +brew install hiredis +``` + +To install on Ubuntu: + +```shell +apt-get install libhiredis-dev +``` + +To install on other platforms: + +```shell +git clone https://github.com/antirez/hiredis.git && cd hiredis && make && sudo make install && sudo ldconfig +``` synopsis