README.md in hella-redis-0.0.1 vs README.md in hella-redis-0.1.0
- old
+ new
@@ -2,10 +2,27 @@
It's-a hella-redis!
## Usage
-TODO: Write code samples and usage instructions here
+### RedisConnection
+
+```ruby
+# config and create a connection
+@config = OpenStruct.new({
+ :timeout => 1,
+ :size => 5,
+ :redis_ns => 'hella-redis-test',
+ :driver => 'ruby',
+ :url => 'redis://localhost:6379/0'
+})
+@conn = HellaRedis::RedisConnection.new(@config)
+
+# it's actually a pool of connections
+@conn.with do |conn|
+ # get a connection and do something with it
+end
+```
## Installation
Add this line to your application's Gemfile: