Skip to content

Commit

Permalink
More release preparation, updating manifest and creating a gitignore …
Browse files Browse the repository at this point in the history
…for hoe release artifacts
  • Loading branch information
Luke Redpath committed Aug 19, 2008
1 parent 9e7d52f commit 05c5106
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 6 deletions.
2 changes: 2 additions & 0 deletions .gitignore
@@ -0,0 +1,2 @@
doc/*
website/*
3 changes: 2 additions & 1 deletion Manifest.txt
@@ -1,7 +1,8 @@
History.txt
License.txt
Manifest.txt
README
README.txt
README.textile
Rakefile
bin/sms
lib/clickatell.rb
Expand Down
33 changes: 33 additions & 0 deletions README.txt
@@ -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.
8 changes: 3 additions & 5 deletions Rakefile
Expand Up @@ -48,14 +48,12 @@ DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"

NAME = "clickatell"
REV = nil
# UNCOMMENT IF REQUIRED:
# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
VERS = Clickatell::VERSION::STRING + (REV ? ".#{REV}" : "")
CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
RDOC_OPTS = ['--quiet', '--title', 'clickatell documentation',
"--opname", "index.html",
"--line-numbers",
"--main", "README",
"--main", "README.txt",
"--inline-source"]

class Hoe
Expand Down Expand Up @@ -129,8 +127,8 @@ task :check_version do
end

Rake::RDocTask.new('docs') do |rd|
rd.main = 'README.txt'
rd.rdoc_files.include('README', 'History.txt', 'License.txt', 'lib/**/*.rb')
rd.main = 'README.textile'
rd.rdoc_files.include('README.txt', 'History.txt', 'License.txt', 'lib/**/*.rb')
rd.rdoc_dir = 'doc'
rd.options << '--style=http://clickatell.rubyforge.org/stylesheets/rdoc.css'
rd.options << '--tab-width=2'
Expand Down

0 comments on commit 05c5106

Please sign in to comment.