client-libraries/ruby/README.markdown

   1 # redis-rb
   2
   3 A ruby client library for the redis key value storage system.
   4
   5 ## Information about redis
   6
   7 Redis is a key value store with some interesting features:
   8 1. It's fast.
   9 2. Keys are strings but values can have types of "NONE", "STRING", "LIST",  or "SET".  List's can be atomically push'd, pop'd, lpush'd, lpop'd and indexed.  This allows you to store things like lists of comments under one key while retaining the ability to append comments without reading and putting back the whole list.
  10
  11 See [redis on code.google.com](http://code.google.com/p/redis/wiki/README) for more information.
  12
  13 ## Dependencies
  14
  15 1. redis -
  16
  17                 rake redis:install
  18
  19 2. dtach -
  20
  21                 rake dtach:install
  22
  23 3. svn - git is the new black, but we need it for the google codes.
  24
  25 ## Setup
  26
  27 Use the tasks mentioned above (in Dependencies) to get your machine setup.
  28
  29 ## Examples
  30
  31 Check the examples/ directory.  *Note* you need to have redis-server running first.