index.html in clickatell-0.4.1

- old
+ new

@@ -14,11 +14,11 @@
 <div id="wrapper">
   <div id="container">
   
   <div id="header">
     
-    <h1>Clickatell Ruby API <span class="version">0.3.0</span>
+    <h1>Clickatell Ruby API <span class="version">0.4.1</span>
     <span class="tagline">gem install clickatell</span></h1>
     
   </div>
   
   <div id="content">
@@ -29,19 +29,24 @@
 
 
 	<h3>Installing</h3>
 
 
+<p><strong>Please note:</strong> this gem has been tested on *nix based systems including Linux, <span class="caps">BSD</span> and <span class="caps">OSX</span>. The <code>sms</code> utility was written with these systems in mind and will not work out of the box on Windows. The <span class="caps">API</span> should still work but has not been tested at this time. If you would like Windows support, please submit patches.</p>
+
 <p>Download the <a href="http://rubyforge.org/projects/clickatell">latest version of gem</a> or install using RubyGems.</p>
 
 <pre><code>$ sudo gem install clickatell</code></pre>
 
 	<p>Getting the latest version from Subversion:</p>
 
 
-<pre><code>&#38; svn co svn://lukeredpath.co.uk/var/svn/opensource/clickatell/trunk clickatell-trunk</code></pre>
+<pre><code>$ svn co svn://lukeredpath.co.uk/var/svn/opensource/clickatell/trunk clickatell-trunk</code></pre>
 
+	<p>You can view the <a href="/rdoc">RDoc documentation</a> and the <a href="/specs.html">code specs</a>.</p>
+
+
 	<h3>The basics</h3>
 
 
 	<p>To use this gem, you will need sign up for an account at <a href="http://www.clickatell.com">the Clickatell website</a>. 
 Once you are registered and logged into your account centre, you should add 
@@ -57,17 +62,24 @@
 
 <pre><code class="ruby">
 require 'rubygems'
 require 'clickatell'
 
-connection = Clickatell::Connection.new('your_api_id', 'your_username', 'your_password')
-connection.send_message('447771234567', 'Hello from clickatell')
+api = Clickatell::API.authenticate('your_api_id', 'your_username', 'your_password')
+api.send_message('447771234567', 'Hello from clickatell')
 </code></pre>
 
 	<p>Full documentation for the <span class="caps">API</span> is available in the <a href="rdoc/">RDocs</a>.</p>
 
 
+	<p>For debugging purposes, the <span class="caps">API</span> allows you to view gateway URIs as they are requested, printed to $stdout. You can enable this by turning on <ins>debug_mode</ins>.</p>
+
+
+<pre><code class="ruby">
+Clickatell::API.debug_mode = true
+</code></pre>
+
 	<h4>Command-line <span class="caps">SMS</span> Utility</h4>
 
 
 	<p>The Clickatell gem also comes with a command-line utility that will allow you
 to send an <span class="caps">SMS</span> directly from the command-line.</p>
@@ -147,10 +159,10 @@
   
   <div id="footer_wrapper">
   	<div id="footer">
   	  <p class="copyright">
         <a href="http://rubyforge.org/projects/clickatell">Rubyforge Project Page</a> | 
-        <a href="http://rubyforge.org/frs/?group_id=4295&amp;release_id=13922">Download latest version (0.3.0)</a> | 
+        <a href="http://rubyforge.org/frs/?group_id=4295&amp;release_id=13922">Download latest version (0.4.1)</a> | 
         <a href="rdoc/">RDoc</a>
       </p>
   	</div>
   </div>
 </div>