README.md in cellular-1.0.0 vs README.md in cellular-1.1.0
- old
+ new
@@ -1,10 +1,16 @@
# Cellular
+[![Gem Version](https://badge.fury.io/rb/cellular.png)](https://rubygems.org/gems/cellular)
+[![Build Status](https://secure.travis-ci.org/hyperoslo/cellular.png?branch=master)](https://travis-ci.org/hyperoslo/cellular)
+[![Dependency Status](https://gemnasium.com/hyperoslo/cellular.png)](https://gemnasium.com/hyperoslo/cellular)
+[![Code Climate](https://codeclimate.com/github/hyperoslo/cellular.png)](https://codeclimate.com/github/hyperoslo/cellular)
+[![Coverage Status](https://coveralls.io/repos/hyperoslo/cellular/badge.png?branch=master)](https://coveralls.io/r/hyperoslo/cellular)
+
Sending and receiving SMSs with Ruby through pluggable backends.
-**Supported Ruby versions: 1.9 or higher**
+**Supported Ruby versions: 1.9.3 or higher**
Licensed under the **MIT** license, see LICENSE for more information.
## Installation
@@ -22,15 +28,45 @@
$ gem install cellular
## Usage
-Usage instructions to follow shortly.
+### Configuration
+```ruby
+Cellular.configure do |config|
+ config.username = 'username'
+ config.password = 'password'
+ config.backend = Cellular::Backends::Sendega
+end
+```
+
+### Available Backends
+
+* CoolSMS (http://coolsms.com/)
+* Sendega (http://sendega.com/)
+
+
+### Sending SMSs
+
+The options supported may differ between backends.
+
+```ruby
+sms = Cellular::SMS.new(
+ recipient: '47xxxxxxxx',
+ sender: 'Custom sender',
+ country: 'NO',
+ message: 'This is an SMS message'
+)
+
+sms.deliver
+```
+
+
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
-5. Create pull Request
+5. Create pull request