README.rdoc in stomp-1.2.5 vs README.rdoc in stomp-1.2.6

@@ -8,10 +8,11 @@
 
 * [STOMP 1.0 and 1.1] (http://stomp.github.com/index.html)
 
 ===New
 
+* Gem version 1.2.6. Miscellaneous fixes and changes. See _CHANGELOG.rdoc_ for details.
 * Gem version 1.2.5. Restructure. Forks with modifcations will be affected. See _CHANGELOG.rdoc_ for details.
 * Gem version 1.2.4. Stomp 1.1 heartbeat fix, autoflush capability, miscellaneous fixes.
 * Gem version 1.2.3. Miscellaneous fixes, see changelog for details.
 * Gem version 1.2.2. Performance and more SSL enhancements.
 * Full support of SSL certificates is announced as of gem version 1.2.1.
@@ -21,27 +22,30 @@
 
 ===Hash Login Example Usage (this is the recommended login technique)
 
   hash = {
       :hosts => [
+        # First connect is to remotehost1
         {:login => "login1", :passcode => "passcode1", :host => "remotehost1", :port => 61612, :ssl => true},
+        # First failover connect is to remotehost2
         {:login => "login2", :passcode => "passcode2", :host => "remotehost2", :port => 61613, :ssl => false},
         
       ],
-      # These are the default parameters, don't need to be set
-      :reliable => true, # true for hash login
-      :initial_reconnect_delay => 0.01,
-      :max_reconnect_delay => 30.0,
-      :use_exponential_back_off => true,
-      :back_off_multiplier => 2,
-      :max_reconnect_attempts => 0,
-      :randomize => false,
-      :backup => false,
-      :timeout => -1,
-      :connect_headers => {},
-      :parse_timeout => 5,
-      :logger => nil,
+      # These are the default parameters and do not need to be set
+      :reliable => true,                  # reliable (use failover)
+      :initial_reconnect_delay => 0.01,   # initial delay before reconnect (secs)
+      :max_reconnect_delay => 30.0,       # max delay before reconnect
+      :use_exponential_back_off => true,  # increase delay between reconnect attpempts
+      :back_off_multiplier => 2,          # next delay multiplier
+      :max_reconnect_attempts => 0,       # retry forever, use # for maximum attempts
+      :randomize => false,                # do not radomize hosts hash before reconnect
+      :connect_headers => {},             # user supplied CONNECT headers (req'd for Stomp 1.1+)
+      :parse_timeout => 5,                # receive / read timeout, secs
+      :logger => nil,                     # user suplied callback logger instance
+      :dmh => false,                      # do not support multihomed IPV4 / IPV6 hosts during failover
+      :closed_check => true,              # check first if closed in each protocol method
+      :hbser => false,                    # raise on heartbeat send exception
     }
     
     # for client
     client = Stomp::Client.new(hash)
     
@@ -99,11 +103,11 @@
 * Brian McCallister
 * Glenn Rempe <[e-mail]>
 * jstrachan 
 * Marius Mathiesen <[e-mail]>
 * Johan S√∏rensen <[e-mail]>
-* Thiago Morello <[e-mail]>
-* Guy M. Allard
+* Thiago Morello
+* Guy M. Allard <[e-mail]>
 * kookster
 * Tony Garnock-Jones <[e-mail]>
 * chirino
 * Stefan Saasen
 * Neil Wilson