file.README.html in clavem-2.0.0

- old
+ new

@@ -1,14 +1,14 @@
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII" />
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
 <title>
   File: README
   
-    &mdash; Documentation by YARD 0.8.6.2
+    &mdash; Documentation by YARD 0.8.7
   
 </title>
 
   <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
 
@@ -80,56 +80,63 @@
 <p>clavem allows you to handle a full oAuth authentication flow directly from the console.</p>
 
 <p>Simply instantiate the authorizer and run the authorize method with the URL:</p>
 
 <p>```ruby
-require &#8220;clavem&#8221;</p>
+require “clavem”</p>
 
 <h1 id="initialize-your-oauth-access">Initialize your oAuth access.</h1>
 
 <p>authorizer = Clavem::Authorizer.new</p>
 
-<h1 id="get-your-authorization-url-and-append-the-callback">Get your authorization URL and append the callback.</h1>
-
-<p>url += &#8220;?oauth_callback=#authorizerauthorizer.callback_url&#8221;
+<h1 id="get-the-token">Get the token</h1>
+<p># You can also handle callback parameter by yourself.
+# url += “?oauth_callback=#authorizerauthorizer.callback_url”
+# authorizer.authorize(url, false)
 authorizer.authorize(url)</p>
 
-<p>if authorizer.status == :succeeded then
+<p>if authorizer.succeeded? then
   access_token = authorizer.token</p>
 
 <p># Go on!
 else
-  # Authorization denied
+  # Authorization denied or failed
 end
 ```</p>
 
 <p>Alternatively, you can also specify a timeout and a block to the constructor to customizer the response handling.</p>
 
 <p>See the <a href="http://rdoc.info/gems/clavem">documentation</a> for more information.</p>
 
+<h2 id="use-on-jruby">Use on jRuby</h2>
+
+<p>To use on jRuby, you need to install a gem with C extensions which must be compiled.</p>
+
+<p>See jRuby documentation to see how to enabled extensions compilation.</p>
+
 <h2 id="contributing-to-clavem">Contributing to clavem</h2>
 
 <ul>
-  <li>Check out the latest master to make sure the feature hasn&#8217;t been implemented or the bug hasn&#8217;t been fixed yet.</li>
-  <li>Check out the issue tracker to make sure someone already hasn&#8217;t requested it and/or contributed it.</li>
+  <li>Check out the latest master to make sure the feature hasn’t been implemented or the bug hasn’t been fixed yet.</li>
+  <li>Check out the issue tracker to make sure someone already hasn’t requested it and/or contributed it.</li>
   <li>Fork the project.</li>
   <li>Start a feature/bugfix branch.</li>
   <li>Commit and push until you are happy with your contribution.</li>
-  <li>Make sure to add tests for it. This is important so I don&#8217;t break it in a future version unintentionally.</li>
+  <li>Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.</li>
   <li>Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.</li>
 </ul>
 
 <h2 id="copyright">Copyright</h2>
 
-<p>Copyright (C) 2013 and above Shogun (shogun_panda@me.com).</p>
+<p>Copyright (C) 2013 and above Shogun (shogun@cowtech.it).</p>
 
 <p>Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.</p>
 </div></div>
 
     <div id="footer">
-  Generated on Sat Jul 20 13:46:58 2013 by
+  Generated on Wed Aug 21 16:17:53 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.6.2 (ruby-1.9.3).
+  0.8.7 (ruby-2.0.0).
 </div>
 
   </body>
 </html>
\ No newline at end of file