index.html in contentful-1.0.0

- old
+ new

@@ -331,10 +331,27 @@
 <h3 id="label-3Aport_password-2C+-3Aport_username">:port_password, :port_username</h3>
 
 <p>To use the proxy with authentication, you need to specify
 <code>port_username</code> and <code>port_password</code>.</p>
 
+<h3 id="label-3Amax_rate_limit_retries">:max_rate_limit_retries</h3>
+
+<p>To increase or decrease the retry attempts after a 429 Rate Limit error.
+Default value is 1. Using 0 will disable retry behaviour. Each retry will
+be attempted after the value (in seconds) of the
+<code>X-Contentful-RateLimit-Reset</code> header, which contains the amount
+of seconds until the next non rate limited request is available, has
+passed. This is blocking per execution thread.</p>
+
+<h3 id="label-3Amax_rate_limit_wait">:max_rate_limit_wait</h3>
+
+<p>Maximum time to wait for next available request (in seconds). Default value
+is 60 seconds. Keep in mind that if you hit the houly rate limit maximum,
+you can have up to 60 minutes of blocked requests. It is set to a default
+of 60 seconds in order to avoid blocking processes for too long, as rate
+limit retry behaviour is blocking per execution thread.</p>
+
 <h3 id="label-Proxy+example">Proxy example</h3>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'>Contentful</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
   <span class='label'>access_token:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>b4c0n73n7fu1</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
   <span class='label'>space:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cfexampleapi</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
@@ -489,12 +506,12 @@
 <p>Copyright © 2014 Contentful GmbH - Jan Lelis. See LICENSE.txt for further
 details.</p>
 </div></div>
 
       <div id="footer">
-  Generated on Tue Aug  9 15:50:42 2016 by
+  Generated on Tue Aug 23 13:38:28 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.5 (ruby-2.2.3).
+  0.9.5 (ruby-2.3.1).
 </div>
 
     </div>
   </body>
 </html>
\ No newline at end of file