README.md in trumail-2.0.1 vs README.md in trumail-2.1.0

- old
+ new

@@ -22,21 +22,25 @@ $ gem install trumail ## Usage -### Lookup Verification +### Lookup ```ruby # Basic Lookup lookup = Trumail::Lookup.new('test@email.com').verify lookup = Trumail::Lookup.verify('test@email.com') # Custom Host -lookup = Trumail::Lookup.verify('test@email.com', host: 'https://verifier.com', format: :xml) +lookup = Trumail::Lookup.verify( + 'test@email.com', + host: 'https://verifier.com', + format: :xml +) ``` -### Lookup Methods +### Response ```ruby lookup.url => 'https://api.trumail.io/v2/lookup/json?email=test@email.com' lookup.hash => { 'address' => 'test@email.com', 'catchAll' => true, ... } lookup.success? => true @@ -57,14 +61,22 @@ lookup.host_exists? => false lookup.role? => false lookup.valid_format? => true ``` +## Development + +After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 -Your contribution is welcome. +Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/trumail. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. -1. Fork it -2. Create your feature branch (`git checkout -b my-new-feature`) -3. Commit your changes (`git commit -am 'Added some feature'`) -4. Push to the branch (`git push origin my-new-feature`) -5. Create new Pull Request +## License + +The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). + +## Code of Conduct + +Everyone interacting in the Trumail project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/trumail/blob/master/CODE_OF_CONDUCT.md).