lib/lunar/connection.rb in lunar-0.5.0 vs lib/lunar/connection.rb in lunar-0.5.1

@@ -1,6 +1,17 @@
 module Lunar
+  # This is actually taken from Ohm (http://ohm.keyvalue.org). The Lunar module 
+  # extends this to make the API easier to use.
+  #
+  #   Lunar.connect(:host => "127.0.0.1", :port => "6380")
+  #   Lunar.redis
+  #   # basically returns Redis.new(:host => "127.0.0.1", :port => "6380")
+  #
+  #   # If you don't provide any connection, it assumes you are referring
+  #   # to the default redis host / port (127.0.0.1 on port 6379)
+  #   Lunar.redis
+  #
   module Connection
     # Connect to a redis database.
     #
     # @param options [Hash] options to create a message with.
     # @option options [#to_s] :host ('127.0.0.1') Host of the redis database.
@@ -46,6 +57,6 @@
     # stores the connection options. used by Lunar::Connection::connect
     def options
       @options || []
     end
   end
-end
\ No newline at end of file
+end