mediaburst-rails

= Mediaburst-Rails

Mediaburst-Rails is a Ruby Gem providing Rails 3.0 extensions to the Ruby Mediaburst SMS Gem (https://github.com/mediaburst/ruby-mediaburst-sms).

== Installation

To use Mediaburst-Rails with Rails 3.0, simply specify the gem in your application's Gemfile:

gem 'mediaburst-rails'

== Configuration

To use Mediaburst-Rails, you will need an SMS API account with Mediaburst Limited. For details, see http://www.mediaburst.co.uk/api/prices.

You specify your configuration in config/mediaburst.yml:

defaults: &defaults
  username: my_username
  password: my_password
  from: MyApp
  unique_id: true

development:
  <<: *defaults
  from: MyAppDev

test:
  <<: *defaults
  from: MyAppTest

To automatically generate a suitable configuration file, a Rails generator is included:

$ rails generate mediaburst:config

== Usage

client = Mediaburst::API.new
client.send_message('447890654321', 'This is an SMS message')

For additional usage, please refer to the Ruby Mediaburst SMS Gem (https://github.com/mediaburst/ruby-mediaburst-sms).

== Note on Patches/Pull Requests

• Fork the project.
• Make your feature addition or bug fix.
• Add tests for it. This is important so I don't break it in a future version unintentionally.
• Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
• Send me a pull request. Bonus points for topic branches.

== Copyright

Copyright (c) 2010 Matthew Gibbons. See LICENSE for details.