Permalink
Browse files

Added README

  • Loading branch information...
1 parent e6f6943 commit e3f945fad9366513e19a3de139f31538fd99e77d @kmerenkov kmerenkov committed May 12, 2010
Showing with 30 additions and 0 deletions.
  1. +30 −0 README.md
View
@@ -0,0 +1,30 @@
+rutabaga
+========
+
+Asynchronous [Redis](http://redis-db.com/) client that works withing [Tornado](http://tornadoweb.org/) IO loop.
+
+
+Usage
+-----
+
+ >>> import rutabaga
+ >>> c = rutabaga.Client()
+ >>> c.connection.connect()
+ >>> def on_result(data, error):
+ print data or error
+ >>> c.set('foo', 'bar', on_result)
+ >>> c.get('foo', on_result)
+ >>> c.hgetall('foo', on_result)
+ >>> c.connection._stream.io_loop.start() # start tornado mainloop
+ True
+ bar
+ ResponseError (on HGETALL [('foo',), {}]): Operation against a key holding the wrong kind of value
+
+
+Credits
+-------
+rutabaga is developed and maintained by [Konstantin Merenkov](mailto:kmerenkov@gmail.com)
+
+ * Inspiration: [redis-py](http://github.com/andymccurdy/redis-py)
+ * Third-party software: [adisp](https://code.launchpad.net/adisp)
+

0 comments on commit e3f945f

Please sign in to comment.