website/index.html in clickatell-0.1.0 vs website/index.html in clickatell-0.2.0
- old
+ new
@@ -14,11 +14,11 @@
<div id="wrapper">
<div id="container">
<div id="header">
- <h1>Clickatell Ruby API 0.1.0
+ <h1>Clickatell Ruby API <span class="version">0.2.0</span>
<span class="tagline">gem install clickatell</span></h1>
</div>
<div id="content">
@@ -29,14 +29,19 @@
<h3>Installing</h3>
-<p>Download the <a href="http://rubyforge.org/projects/clickatell">latest version of gem</a> or install using RubyGems</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>& svn co svn://lukeredpath.co.uk/var/svn/opensource/clickatell/trunk clickatell-trunk</code></pre>
+
<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
@@ -56,10 +61,13 @@
connection = Clickatell::Connection.new('your_api_id', 'your_username', 'your_password')
connection.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>
+
+
<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>
@@ -74,17 +82,37 @@
api_key: your_api_id
username: your_username
password: your_password
</code></pre>
- <p>You can then use the sms utility to send a message to a single recipient:</p>
+ <p>You can then use the <ins>sms</ins> utility to send a message to a single recipient:</p>
<pre><code>
$ sms 447771234567 'Hello from clickatell'
</code></pre>
+ <p>Alternatively, you can specify your authentication details manually by passing in options to the <ins>sms</ins> command.</p>
+
+
+<pre><code>
+$ sms -u your_username -p your_password -k your_api_key 447771234567 'Hello from clickatell'
+</code></pre>
+
+ <p>These values will take presedence over any values in your ~/.clickatell file.</p>
+
+
+ <p>You can also use the <ins>sms</ins> utility to check your Clickatell account balance:</p>
+
+
+<pre><code>
+$ sms --show-balance
+</code></pre>
+
+ <p>Run <ins>sms</ins> without any arguments for a full list of options.</p>
+
+
<h3>License</h3>
<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
@@ -99,10 +127,11 @@
<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/projects/clickatell">Download latest version (0.1.0)</a>
+ <a href="http://rubyforge.org/frs/?group_id=4295&release_id=13922">Download latest version (0.2.0)</a> |
+ <a href="rdoc/">RDoc</a>
</p>
</div>
</div>
</div>