README.md in ebanx-0.1.0 vs README.md in ebanx-1.0.0

- old
+ new

@@ -1,29 +1,62 @@ -# Ebanx +# EBANX Ruby gem [![Build Status](https://travis-ci.org/ebanx-integration/ebanx-ruby.svg?branch=master)](https://travis-ci.org/ebanx-integration/ebanx-ruby) [![Code Climate](https://codeclimate.com/github/ebanx-integration/ebanx-ruby/badges/gpa.svg)](https://codeclimate.com/github/ebanx-integration/ebanx-ruby) [![Test Coverage](https://codeclimate.com/github/ebanx-integration/ebanx-ruby/badges/coverage.svg)](https://codeclimate.com/github/ebanx-integration/ebanx-ruby/coverage) +Gem to communicate with EBANX. -TODO: Write a gem description +Documentation: https://developers.ebanx.com/ ## Installation -Add this line to your application's Gemfile: +Add this line to your application's Gemfile, and bundle it: - gem 'ebanx' +``` +gem 'ebanx' +$ bundle +``` -And then execute: - - $ bundle - Or install it yourself as: $ gem install ebanx ## Usage -TODO: Write usage instructions here +#### Create a new Boleto using Direct API +```ruby +response = ebanx.do_direct { + operation: 'request', + mode: 'full', + payment: { + name: 'João da Silva', + email: 'joao@mailinator.com', + currency_code: 'USD', + amount_total: 100.50, + merchant_payment_code: Random.rand(10000000000), + payment_type_code: 'boleto', + person_type: 'personal', + document: '13326724691', + birth_date: '01/01/1980', + zipcode: '70000-000', + address: 'Rua Brasil', + street_number: '1', + city: 'Brasília', + state: 'DF', + country: 'br', + phone_number: '6130001111', + due_date: (Time.now + 86400).strftime('%d/%m/%Y') + } +} +``` + +## Automated Tests +We use minitest for testing this Gem. + +``` +rake test +``` + ## 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 new Pull Request +5. Create new Pull Request \ No newline at end of file