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

# redis-clojure

A Clojure client library for the
[Redis](http://code.google.com/p/redis) key value storage system.

## Dependencies

To use redis-clojure, you'll need:

* The [Clojure](http://clojure.org) programming language
* The [Clojure-Contrib](http://code.google.com/p/clojure-contrib) library (for running the tests)

## Building 

To build redis-clojure:

    ant -Dclojure.jar=/path/to/clojure.jar

This will build `redis-clojure.jar`.

## Running tests

To run tests:

    ant -Dclojure.jar=/path/to/clojure.jar -Dclojure-contrib.jar=/path/to/clojure-contrib.jar test

*Note* you need to have `redis-server` running first.

## Using

To use redis-clojure in your application, simply make sure either
`redis-clojure.jar` or the contents of the `src/` directory is on your
classpath.

This can be accomplished like so:

    (add-classpath "file:///path/to/redis-clojure.jar")

## Examples

Check the `examples/` directory.

*Note* you need to have `redis-server` running first.

## Todo

* Work on performance
* Maybe implement pipelining
Commit	Line	Data
e59229a2	1	# redis-clojure
	2
	3	A Clojure client library for the
	4	[Redis](http://code.google.com/p/redis) key value storage system.
	5
	6	## Dependencies
	7
	8	To use redis-clojure, you'll need:
	9
	10	* The [Clojure](http://clojure.org) programming language
	11	* The [Clojure-Contrib](http://code.google.com/p/clojure-contrib) library (for running the tests)
	12
	13	## Building
	14
	15	To build redis-clojure:
	16
	17	ant -Dclojure.jar=/path/to/clojure.jar
	18
	19	This will build `redis-clojure.jar`.
	20
	21	## Running tests
	22
	23	To run tests:
	24
	25	ant -Dclojure.jar=/path/to/clojure.jar -Dclojure-contrib.jar=/path/to/clojure-contrib.jar test
	26
	27	Note you need to have `redis-server` running first.
	28
	29	## Using
	30
	31	To use redis-clojure in your application, simply make sure either
	32	`redis-clojure.jar` or the contents of the `src/` directory is on your
	33	classpath.
	34
	35	This can be accomplished like so:
	36
	37	(add-classpath "file:///path/to/redis-clojure.jar")
	38
	39	## Examples
	40
	41	Check the `examples/` directory.
	42
	43	Note you need to have `redis-server` running first.
	44
	45	## Todo
	46
	47	* Work on performance
	48	* Maybe implement pipelining
	49