Merge pull request #9 from PagaMasTarde/v7.0.0

V7.2.0
pagantis · Feb 22, 2019 · da56db4 · da56db4
2 parents 214bd5d + 0b77a6d
commit da56db4
Show file tree

Hide file tree

Showing 49 changed files with 2,553 additions and 1,643 deletions.
diff --git a/Documentation/configuration.md b/Documentation/configuration.md
@@ -0,0 +1,24 @@
+# Configuration
+
+## :house: Access
+
+To access to Paga+Tarde admin panel, we need to open the Woocommerce admin panel and follow the next steps:
+
+1 – Woocommerce => Settings
+![Step 1](./woocommerce_configuration_1.png?raw=true "Step 1")
+
+2 – Checkout => Paga+Tarde
+![Step 2](./woocommerce_configuration_2.png?raw=true "Step 2")
+
+3 – Paga+Tarde
+![Step 3](./woocommerce_configuration_3.png?raw=true "Step 3")
+
+## :clipboard: Options
+In Paga+tarde admin panel, we can set the following options:
+
+| Field &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;| Description<br/><br/>
+| :------------- |:-------------| 
+| Activate plugin   | - Clicked => Module enabled<br/> - Not clicked => Módule disabled (Default)
+| Public Key(*) |  String you can get from your [Paga+Tarde profile](https://bo.pagamastarde.com/shop).
+| Secret Key(*) |  String you can get from your [Paga+Tarde profile](https://bo.pagamastarde.com/shop). 
+| Product Simulator    |  Choose if we want to use installments simulator inside product page.
diff --git a/Documentation/installation.md b/Documentation/installation.md
@@ -0,0 +1,36 @@
+# Installation
+
+## :wrench: Admin panel
+
+To install the plugin of Paga+Tarde in your Woocommerce shop, we need to open the Woocommerce admin panel and follow the next steps:
+
+#### Common steps
+1. Plugins => Add new
+![Step 1](./woocommerce_installation_1.png?raw=true "Step 1")
+
+2. Choose installation method.
+
+![Step 2](./woocommerce_installation_2.png?raw=true "Step 2")
+
+#### Installation using marketplace
+3. Click on "Install now"
+![Step 3](./woocommerce_installation_3a.png?raw=true "Step 3")
+
+4. Click on "Enable"
+![Step 4](./woocommerce_installation_4a.png?raw=true "Step 4")
+
+#### Installation using zip file
+3. Download the zip file from [here](https://github.com/pagamastarde/woocommerce/releases/latest). The name could be different according the last version of the plugin(Vx.x.x)
+![Step 3](./woocommerce_installation_3b.png?raw=true "Step 3")
+
+4. Click 'Upload plugin'
+![Step 4](./woocommerce_installation_4b.png?raw=true "Step 4")
+
+5. Select the downloaded file and click 'Open'.
+![Step 5](./woocommerce_installation_5b.png?raw=true "Step 5")
+
+6. Click on 'Install'
+![Step 6](./woocommerce_installation_6b.png?raw=true "Step 6")
+
+7. Enable the plugin on the plugins dashboard
+![Step 7](./woocommerce_installation_7b.png?raw=true "Step 7")
diff --git a/Documentation/use.md b/Documentation/use.md
@@ -0,0 +1,11 @@
+# Use
+
+## :eyes: Checkout
+
+If the plugin is enabled and configured rightly, you can see Paga+Tarde like new payment method in checkout.
+
+In Paga+Tarde admin panel we can modify title, description and installment simulator.
+
+![Step 1](./woocommerce_checkout.png?raw=true "Step 1")
+
+After press "Place order" button, the user will be redirected to Paga+Tarde side or watch our form in a pop-up over checkout page, according with the configuration in our Paga+Tarde admin panel.
diff --git a/Documentation/woocommerce_checkout.png b/Documentation/woocommerce_checkout.png
diff --git a/Documentation/woocommerce_configuration_1.png b/Documentation/woocommerce_configuration_1.png
diff --git a/Documentation/woocommerce_configuration_2.png b/Documentation/woocommerce_configuration_2.png
diff --git a/Documentation/woocommerce_configuration_3.png b/Documentation/woocommerce_configuration_3.png
diff --git a/Documentation/woocommerce_installation_1.png b/Documentation/woocommerce_installation_1.png
diff --git a/Documentation/woocommerce_installation_2.png b/Documentation/woocommerce_installation_2.png
diff --git a/Documentation/woocommerce_installation_3a.png b/Documentation/woocommerce_installation_3a.png
diff --git a/Documentation/woocommerce_installation_3b.png b/Documentation/woocommerce_installation_3b.png
diff --git a/Documentation/woocommerce_installation_4a.png b/Documentation/woocommerce_installation_4a.png
diff --git a/Documentation/woocommerce_installation_4b.png b/Documentation/woocommerce_installation_4b.png
diff --git a/Documentation/woocommerce_installation_5b.png b/Documentation/woocommerce_installation_5b.png
diff --git a/Documentation/woocommerce_installation_6b.png b/Documentation/woocommerce_installation_6b.png
diff --git a/Documentation/woocommerce_installation_7b.png b/Documentation/woocommerce_installation_7b.png
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -25,7 +25,7 @@ module.exports = function(grunt) {
                     {src: ['templates/**'], dest: 'paylater/', filter: 'isFile'},
                     {src: ['vendor/**'], dest: 'paylater/', filter: 'isFile'},
                     {src: 'WC_Paylater.php', dest: 'paylater/'},
-                    {src: 'readme.txt', dest: 'paylater/'},
+                    {src: 'readme.txt', dest: 'paylater/'}
                 ]
             }
         }

diff --git a/README.md b/README.md
@@ -1,41 +1,40 @@
-# Woocommerce Module <img src="https://pagamastarde.com/img/icons/logo.svg" width="100" align="right">
+# Module installation <img src="https://pagamastarde.com/img/icons/logo.svg" width="100" align="right">
 
 [![Build Status](https://travis-ci.org/PagaMasTarde/WooCommerce.svg?branch=master)](https://travis-ci.org/PagaMasTarde/WooCommerce)
 [![Latest Stable Version](https://poser.pugx.org/pagamastarde/woocommerce/v/stable)](https://packagist.org/packages/pagamastarde/woocommerce)
 [![composer.lock](https://poser.pugx.org/pagamastarde/woocommerce/composerlock)](https://packagist.org/packages/pagamastarde/woocommerce)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/PagaMasTarde/woocommerce/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/PagaMasTarde/woocommerce/?branch=master)
 
-## Instrucciones de Instalación
-1. Crea tu cuenta en pagamastarde.com si aún no la tienes [desde aquí](https://bo.pagamastarde.com/users/sign_up)
-2. Descarga el módulo de [aquí](https://github.com/pagamastarde/woocommerce/releases/latest)
-3. Instala el módulo en tu woocommerce
-4. Configuralo con la información de tu cuenta que encontrarás en [el panel de gestión de Paga+Tarde](https://bo.pagamastarde.com/shop). Ten en cuenta que para hacer cobros reales deberás activar tu cuenta de Paga+Tarde.
+## :hand: Requirements
+Wordpress and Woocommerce plugin enabled.
 
-## Modo real y modo de pruebas
+## :floppy_disk: Installation
+To install the plugin of Paga+Tarde in your Woocommerce shop
 
-Tanto el módulo como Paga+Tarde tienen funcionamiento en real y en modo de pruebas independientes. Debes introducir las credenciales correspondientes del entorno que desees usar.
+#### Common steps
+1. Navigate to plugins dashboard
+2. Click on "Add new"
 
-### Soporte
+#### Installation using marketplace
+3. Search for 'PagaMasTarde'
+4. Click 'Install Now'
+5. Click 'Activate'
 
-Si tienes alguna duda o pregunta no tienes más que escribirnos un email a [welcome@pagamastarde.com]
+#### Installation using zip file
+3. Download the zip file from [here](https://github.com/pagamastarde/woocommerce/releases/latest)
+4. Click 'Upload plugin'
+5. Select the downloaded file and click 'Open'.
+6. Click on 'Install'
+7. Activate the plugin on the plugins dashboard
 
-## Development Instructions:
+For more information about how to install the plugin, see our [installation section](/Documentation/installation.md).
 
-To develop or improve this module you need to have installed in your environment
-    * Composer
-
-To make the module operative you need to download the dependencies, 
+## :gear: Configuration
+Configure the plugin in Woocommerce admin panel using the information found in your [Paga+Tarde profile](https://bo.pagamastarde.com/shop). 
 
-    composer install
-
-Once both dependencies are ready you can generate the specific module files using
+For more information about how to config the module, see our [configuration section](/Documentation/configuration.md).
 
-    grunt default
-
-Grunt will compress the CSS and the JS and generate a zip file with the necessary files to push
-to the market.
+## :arrow_forward: Use
+To use in a real environment you should enable your Paga+Tarde account.
 
-### Testing and Improvements
-
-* Doing some phpUnit testing on the module.
-* Improving the code structure to make it more human.
+For more information about how to use the module, see our [use section](/Documentation/use.md).