README.md in mymoip-0.5.0 vs README.md in mymoip-0.6.0
- old
+ new
@@ -1,50 +1,48 @@
-MyMoip
-======
+# MyMoip
MoIP transactions in a gem to call your own.
Provides a implementation of MoIP's transparent checkout.
Planning to use with Rails? Check [my_moip-rails](https://github.com/Irio/my_moip-rails).
-Contributing to MyMoip
-----------------------
+## Contributing to MyMoip
[](http://travis-ci.org/Irio/mymoip)
-[](https://gemnasium.com/Irio/mymoip)
-[](https://codeclimate.com/github/Irio/mymoip)
+[](https://codeclimate.com/github/Irio/mymoip)
What would you do if you could make your own implementation of MoIP?
Any patch are welcome, even removing extra blank spaces.
1. Open a pull request.
2. Done.
-Using
------
+## Using
Currently under active development.
**Bundler - Gemfile**
```ruby
gem 'mymoip'
```
-**Configuration**
+### Configuration
```ruby
MyMoip.environment = "production" # "sandbox" by default
MyMoip.sandbox_token = "your_moip_sandbox_token"
MyMoip.sandbox_key = "your_moip_sandbox_key"
MyMoip.production_token = "your_moip_production_token"
MyMoip.production_key = "your_moip_production_key"
```
-**First request: what and from who**
+### First request: what and from who
+
```ruby
payer = MyMoip::Payer.new(
id: "payer_id_defined_by_you",
name: "Juquinha da Rocha",
email: "juquinha@rocha.com",
@@ -68,36 +66,44 @@
transparent_request = MyMoip::TransparentRequest.new("your_logging_id")
transparent_request.api_call(instruction)
```
-**Second request: how**
+### Second request: how
+
```ruby
credit_card = MyMoip::CreditCard.new(
logo: :visa,
card_number: "4916654211627608",
expiration_date: "06/15",
security_code: "000",
owner_name: "Juquinha da Rocha",
- owner_birthday: Date.new(1984, 11, 3),
+ owner_birthday: "03/11/1984",
owner_phone: "5130405060",
owner_cpf: "52211670695"
)
credit_card_payment = MyMoip::CreditCardPayment.new(credit_card, installments: 1)
payment_request = MyMoip::PaymentRequest.new("your_logging_id")
payment_request.api_call(credit_card_payment, token: transparent_request.token)
```
-**Success?**
+### Success?
```ruby
payment_request.success?
```
-Sending payments to multiple receivers
---------------------------------------
+## More!
+Yes, you should read (and help improve!) the docs.
+
+### Documentation
+
+For more information about usage you can access the [wiki page](https://github.com/Irio/mymoip/wiki).
+
+### Sending payments to multiple receivers
+
Choosing between commission with fixed or percentage value.
```ruby
commissions = [MyMoip::Commission.new(
reason: 'System maintenance',
@@ -122,21 +128,38 @@
payer: payer,
commissions: commissions
)
```
-[Wiki](https://github.com/Irio/mymoip/wiki/Sending-payments-to-multiple-receivers) will be helpful here.
+[More](https://github.com/Irio/mymoip/wiki/Sending-payments-to-multiple-receivers).
-Documentation
--------------
+### Installments
-For more information about usage you can access the [wiki page](https://github.com/Irio/mymoip/wiki).
+The API allows you to set multiple configurations for installments.
-Going alive!
-------------
+On initialization of a MyMoip::Instruction, the #new method accepts a
+installment option which will expect something like this array:
+```ruby
+installments = [
+ { min: 1, max: 1, forward_taxes: false },
+ { min: 2, max: 12, forward_taxes: true, fee: 1.99 } # 1.99 fee = 1.99% per month
+]
+
+MyMoip::Instruction.new(
+ id: "instruction_id_defined_by_you",
+ payment_reason: "Order in Buy Everything Store",
+ values: [100.0],
+ payer: payer,
+ installments: installments
+)
+```
+
+[More](https://github.com/Irio/mymoip/wiki/Installments-use).
+
+## Going alive!
+
If you are ready to get your application using MyMoip approved by MoIP or already have valid production keys, you can read a specific [documentation](https://github.com/Irio/mymoip/wiki/Going-alive).
-License
--------
+## License
MIT. See LICENSE.txt for further details.