README.md in zenvia-rb-0.0.2 vs README.md in zenvia-rb-0.0.3

- old
+ new

@@ -3,11 +3,11 @@ ## Installation Add this line to your application's Gemfile: ```ruby -gem 'zenvia-rb', '~> 0.0.1' +gem 'zenvia-rb', '~> 0.0.2' ``` And then execute: $ bundle @@ -18,28 +18,41 @@ HTTParty is the only dependency for this gem. ## Usage +### Configuration In your script ```ruby + +Zenvia.configure {|config| + config.account = account_given_by_zenvia + config.code = code_given_by_zenvia + config.name = user_or_enterprise_name # optional +} + +``` + +### Usage +```ruby require 'zenvia' -sms = Zenvia.new(USER, CODE) -sms.send_message(FROM, NUMBER, TEXT, DELAY=0) +# if from is nil, the sender name will be set as config.name (as above) +# if you prefer a definitely nil sender, you can set from = '' + +sms = Zenvia::SMS.new(from, number, message) +sms.send_message ``` That's all ;) ## Development -After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. +After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment. -To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). - ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/jeferson/zenvia +Bug reports and pull requests are welcome on GitHub at https://github.com/jefersonhuan/zenvia-rb ## License The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).