RDOC_README.txt

= Clickatell SMS Library

To use this gem, you will need sign up for an account at www.clickatell.com. Once you are registered and logged into your account centre, you should add an HTTP API connection to your account. This will give you your API_ID.

== Basic Usage

You will need your API_ID as well as your account username and password.

  require 'rubygems'
  require 'clickatell'
  
  api = Clickatell::API.authenticate('your_api_id', 'your_username', 'your_password')
  api.send_message('447771234567', 'Hello from clickatell')

  
== Command-line SMS Utility

The Clickatell gem also comes with a command-line utility that will allow you to send an SMS directly from the command-line. 

You will need to create a YAML configuration file in your home directory, in a file called .clickatell that resembles the following:

  # ~/.clickatell
  api_key: your_api_id
  username: your_username
  password: your_password
  
You can then use the sms utility to send a message to a single recipient:

  sms 447771234567 'Hello from clickatell'
  
Alternatively, you can specify the username and password as a command line option. Run +sms+ without any arguments for a full list of options.

See http://clickatell.rubyforge.org for further instructions.