[redis.git] / client-libraries / ruby / README.markdown

# redis-rb

A ruby client library for the redis key value storage system.

## Information about redis

Redis is a key value store with some interesting features:
1. It's fast.
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.

See [redis on code.google.com](http://code.google.com/p/redis/wiki/README) for more information.

## Dependencies

1. rspec - 
		sudo gem install rspec

2. redis - 

		rake redis:install

2. dtach - 

		rake dtach:install

3. git - git is the new black.

## Setup

Use the tasks mentioned above (in Dependencies) to get your machine setup.

## Examples

Check the examples/ directory.  *Note* you need to have redis-server running first.
Commit	Line	Data
ed9b544e	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
d7fc9edb	15	1. rspec -
	16	sudo gem install rspec
	17
	18	2. redis -
ed9b544e	19
	20	rake redis:install
	21
	22	2. dtach -
	23
	24	rake dtach:install
	25
d7fc9edb	26	3. git - git is the new black.
ed9b544e	27
	28	## Setup
	29
	30	Use the tasks mentioned above (in Dependencies) to get your machine setup.
	31
	32	## Examples
	33
	34	Check the examples/ directory. Note you need to have redis-server running first.