Added README.md

Author: imasson

.gitignore

@@ -77,6 +77,7 @@ atlassian*
 !/composer.json
 !/composer.lock
 !/README.md
+!/README.img
 !/.travis.yml
 !/.travis/
 !/.gitignore

README.img/mercadoenvios.png

@@ -0,0 +1,162 @@
+# Magento - Mercado Pago Module (v1.0.5)
+
+* [Features](#features)
+* [Installation](#installation)
+* [Configuration](#configuration)
+* [MercadoEnvios](#mercadoenvios)
+
+<a name="features"></a>
+## Features:
+
+**Credit Card Customized Checkout**
+
+This feature will allow merchants to have a customized checkout for credit card
+payment. Thus, it will be possible to customize its look and feel, customers won’t be
+redirected away to complete the payment, and it will also reduce the checkout steps
+improving conversion rates.
+
+*Available for Argentina, Brazil, Colombia, Mexico and Venezuela*
+
+**Customized Bar Code Payment**
+
+This feature allows merchants to have a customized bar code payment. It
+reduces the checkout steps improving conversion rates. The bar code payment will
+have merchant's logo.
+
+*Available for Argentina, Brazil, Colombia, Mexico and Venezuela*
+
+**Standard Checkout**
+
+This feature allows merchants to have a standard checkout. It includes all
+payment methods (i.e. all credit cards, bar code payment, account money) and all
+window types (i.e. redirect, iframe, modal, blank and popup). Customization is not allowed.
+
+*Available for Argentina, Brazil, Chile, Colombia, Mexico and Venezuela*
+
+**OneClick Pay**
+This feature allows to store credit card information for the customer, so that the next time there is no need to enter all the card details.  Customers will just need to re-enter the security code of the credit card they want to use.
+
+**Shipment integration**
+
+This feature allows to setup and integrate with MercadoEnvios shipment method as another shipment option for customers. It includes the possibility to print the shipping label directly from the Magento Admin Panel. Free shipping is also available.
+
+*Available for Argentina, Brazil and Mexico only with Standard Checkout*
+
+---
+
+<a name="installation"></a>
+## Installation:
+
+1. Copy the folder **app/code/MercadoPago** to the Magento root installation. Make sure to keep the Magento folders structure intact.
+
+2. Enable modules from console.
+
+	  - bin/magento module:enable MercadoPago_Core
+	  - bin/magento module:enable MercadoPago_MercadoEnvios
+    
+    Then update magento with new modules:
+    
+      - bin/magento setup:upgrade 
+
+---
+<a name="configuration"></a>
+## Configuration
+
+1. Go to **Stores > Configuration > Sales > Payment Methods**. Select **Mercado Pago - Global Configuration**.
+![Mercado Pago Global Configuration](/README.img/mercadopago_global_configuration.png?raw=true)<br />

+2. Set your Country to the same where your account was created on, and save config.
+	**Note: If you change the Country where your account was created you need save configuration in order to refresh the excluded payment methods.**
+	
+3. Other general configurations:<br />
+	* **Category of your store**: Sets up the category of the store.
+	* **Choose the status of approved orders**: Sets up the order status when payments are approved.
+	* **Choose the status of refunded orders**: Sets up the order status when payments are refunded.
+	* **Choose the status when payment is pending**: Sets up the order status when payments are pending.
+	* **Choose the status when client open a mediation**: Sets up the order status when client opens a mediation.
+	* **Choose the status when payment was reject**: Sets up the order status when payments are rejected.
+	* **Choose the status when payment was canceled**: Sets up the order status when payments are canceled.
+	* **Choose the status when payment was chargeback**: Sets up the order status when payments are chargeback.
+	* **Logs**: Enables/disables system logs.
+	* **Debug Mode**: If enabled, displays the raw response from the API instead of a friendly message.
+
+<a name="checkout_custom"></a>
+###Custom Checkout Payment Solution:###
+
+1. Go to **Stores > Configuration > Sales > Payment Methods**. Select **Mercado Pago - Custom Checkout**.
+![Mercado Pago Custom Checkout Configuration](/README.img/mercadopago_custom_checkout_configuration.png?raw=true)<br />

+2. Set your **Public Key** and **Access Token**.
+
	In order to get them check the following links according to the country you are operating in:
+	
+	* Argentina: [https://www.mercadopago.com/mla/account/credentials](https://www.mercadopago.com/mla/account/credentials)
+	* Brazil: [https://www.mercadopago.com/mlb/account/credentials](https://www.mercadopago.com/mlb/account/credentials)
+    * Chile: [https://www.mercadopago.com/mlc/herramientas/aplicaciones](https://www.mercadopago.com/mlc/herramientas/aplicaciones)
+	* Colombia: [https://www.mercadopago.com/mco/account/credentials](https://www.mercadopago.com/mco/account/credentials)
+	* Mexico: [https://www.mercadopago.com/mlm/account/credentials](https://www.mercadopago.com/mlm/account/credentials)
+	* Venezuela: [https://www.mercadopago.com/mlv/account/credentials](https://www.mercadopago.com/mlv/account/credentials)
+	* Peru: [https://www.mercadopago.com/mpe/account/credentials](https://www.mercadopago.com/mpe/account/credentials)
+
+
+If you want to enable credit card solution, check the configurations under **Checkout Custom - Credit Card**:
+![Mercado Pago Custom Checkout Credit Card](/README.img/mercadopago_custom_checkout_cc.png?raw=true)<br />

+* **Enabled**: Enables/disables this payment solution.
+* **Payment Title**: Sets the payment title.
+* **Statement Descriptor**: Sets the label as the customer will see the charge for amount in his/her bill.
+* **Binary Mode**: When set to true, the payment can only be approved or rejected. Otherwise in_process status is added.
+* **Banner Checkout**: Sets the URL for the banner image in the payment method selection in the checkout process.
+* **Checkout Position**: The position of the payment solution in the checkout process.
+* **Marketing - Coupon Mercado Pago**: Enables/disables the coupon form.
+
+If you want to enable ticket solution, check the configurations under **Checkout Custom - Ticket**:
+
+![Mercado Pago Custom Checkout Ticket](/README.img/mercadopago_custom_checkout_ticket.png?raw=true)<br />

+* **Enabled**: Enables/disables this payment solution.
+* **Payment Title**: Sets the payment title.
+* **Banner Checkout**: Sets the URL for the banner image in the payment method selection in the checkout process.
+* **Checkout Position**: The position of the payment solution in the checkout process.
+* **Marketing - Coupon Mercado Pago**: Enables/disables the coupon form.
+
+<a name="checkout_standard"></a>
+###Standard Checkout Payment Solution:###
+
+1. Go to **Stores > Configuration > Sales > Payment Methods**. Select **Mercado Pago - Classic Checkout**.
+
+2. Enable the solution and set your **Client Id** and **Client Secret**. <br />
+Get them in the following address:
+	* Argentina: [https://www.mercadopago.com/mla/herramientas/aplicaciones](https://www.mercadopago.com/mla/herramientas/aplicaciones)
+	* Brazil: [https://www.mercadopago.com/mlb/ferramentas/aplicacoes](https://www.mercadopago.com/mlb/ferramentas/aplicacoes)
+	* Chile: [https://www.mercadopago.com/mlc/herramientas/aplicaciones](https://www.mercadopago.com/mlc/herramientas/aplicaciones)
+	* Colombia: [https://www.mercadopago.com/mco/herramientas/aplicaciones](https://www.mercadopago.com/mco/herramientas/aplicaciones)
+	* Mexico: [https://www.mercadopago.com/mlm/herramientas/aplicaciones](https://www.mercadopago.com/mlm/herramientas/aplicaciones)
+	* Venezuela: [https://www.mercadopago.com/mlv/herramientas/aplicaciones](https://www.mercadopago.com/mlv/herramientas/aplicaciones)
+	* Peru: [https://www.mercadopago.com/mpe/herramientas/aplicaciones](https://www.mercadopago.com/mpe/herramientas/aplicaciones)
+
+3. Check the additional configurations:
+	* **Payment Title**: Sets the payment title.
+	* **Banner Checkout**: Sets the URL for the banner image in the payment method selection in the checkout process.
+	* **Checkout Position**: The position of the payment solution in the checkout process.
+	* **Type Checkout**: Sets the type of checkout, the options are:
+		*  *Iframe*: Opens a Magento URL with a iframe as the content.
+		*  *Redirect*: Redirects to Mercado Pago URL.
+		*  *Lightbox*: Similar to Iframe option but opens a lightbox instead of an iframe. 
+
+---
+
+<a name="mercadoenvios">
+## MercadoEnvios ##
+In order to setup MercadoEnvios follow these instructions:<br />
+1. Setup MercadoPago Standard Checkout following [these instructions](#checkout_standard). <br />
+2. Go to **Sales > Configuration > Sales > Shipping Methods > MercadoEnvios**.<br />
+3. Setup the plugin:<br />
+
+![MercadoEnvios Configuration](/README.img/mercadoenvios.png?raw=true)
+
+* **Enabled**: Enables/disables this MercadoEnvios solution.
+* **Title**: Sets up the shipping method label displayed in the shipping section in checkout process.
+* **Product attributes mapping**: Maps the system attributes with the dimensions and weight. Also allows to set up the attribute unit.
+* **Available shipping methods**: Sets up the shipping options visible in the checkout process.
+* **Free Method**: Sets up the method to use as free shipping.
+* **Free Shipping with Minimum Order Amount**: Enables/disables the order minimum for free shipping to be available.
+* **Show method if not applicable**: If enabled, the shipping method is displayed when it's not available.
+* **Displayed Error Message**: Sets up the text to be displayed when the shipping method is not available.
+* **Debug Mode**: If enabled, displays the raw response from the API instead of a friendly message.
+* **Sort order**: Sets up the sort order to be displayed in the shipping step in checkout process.