Documented EM::Hiredis.connect

mloughran · Apr 12, 2013 · f94b41c · f94b41c
1 parent 5522a58
commit f94b41c
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/lib/em-hiredis.rb b/lib/em-hiredis.rb
@@ -23,6 +23,13 @@ def self.setup(uri = nil)
       client
     end
 
+    # Connects to redis and returns a client instance
+    #
+    # Will connect in preference order to the provided uri, the REDIS_URL
+    # environment variable, or localhost:6379
+    #
+    # TCP connections are supported via redis://:password@host:port/db (only
+    # host and port components are required)
     def self.connect(uri = nil)
       client = setup(uri)
       client.connect