forked from lukeredpath/clickatell
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
More release preparation, updating manifest and creating a gitignore …
…for hoe release artifacts
- Loading branch information
Luke Redpath
committed
Aug 19, 2008
1 parent
9e7d52f
commit 05c5106
Showing
4 changed files
with
40 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
doc/* | ||
website/* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,8 @@ | ||
History.txt | ||
License.txt | ||
Manifest.txt | ||
README | ||
README.txt | ||
README.textile | ||
Rakefile | ||
bin/sms | ||
lib/clickatell.rb | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
= 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters