README.md

README.md

@@ -1,12 +1,56 @@
-# Magento 2 Payline Module #
+# [![Monext Logo](doc/logo-monext.svg)](https://www.monext.fr/)
 
-## Compatibility ##
-Magento >= 2.3
+# Monext Magento 2 Module
 
-## Installation (EN)
+
+
+
+----
+
+## Table of Content
+
+* [Overview](#overview)
+* [Features](#features)
+* [Installation](#installation)
+    * [Requirements](#requirements)
+    * [Installation process](#installation-process)
+* [Configuration](#configuration)
+* [Additional resources for developers](#additional-resources-for-developers)
+* [License](#license)
+* [Contact and support](#contact-and-support)
+
+## Overview
+
+This plugin allows you to use the Monext payment system with a Magento 2 ecommerce application.
+
+
+## Features
+
+This plugin integrate with native Magento 2 orders' workflow and provides the following features:
+It allows you to:
+* Do onsite payment with embedded widget or offsite on a payment page hosted by Monext.
+* Cancel payments.
+* Refund payments.
+
+### Supported payment methods
+
+This plugin supports several payment methods.
+You can also check [our documentation](https://docs.monext.fr/display/DT/Payment+Method) for more information about other supported payment methods.
+
+## Installation
+
+### Requirements
+
+* Magento >= 2.3
+
+### Installation process
+
+#### Using composer
+
+#### Using archive
 
 Log in to the Magento server, go to your Magento install dir.
- 
+
 You have to create a new directory to store the module zip package, payline-magento2-__x.y.z__.zip (__x.y.z__ is the version of the module).
  ```
 mkdir -p extra/composer/artifact/zip
@@ -26,37 +70,58 @@ php -f bin/magento module:enable Monext_Payline
 php -f bin/magento setup:upgrade
 ```
 
+## Configuration
 
-## Installation  (FR)
+Here are the main configuration fields for the payment method:
 
-Se connecter en ssh sur le serveur qui héberge Magento et se positionner dans le répertoire d'installation.
-
-Si il n'existe pas encore, créer le répertoire extra/composer/artifact/zip pour stocker l'archive du module (payline-magento2-__x.y.z__.zip, __x.y.z__ étant la version du module).
- ```
-mkdir -p extra/composer/artifact/zip
-```
+* Open configuration menu under STORES > Settings > Configuration > SALES > Payment Methods > Monext
 
-Copier l'archive du module payline-magento2-__x.y.z__.zip dans ce  répertoire ( extra/composer/artifact/zip )
+![Screenshot showing payment method configuration in backoffice](doc/config.png)
 
-Lancer composer pour déployer le module et ses dépendances (_monext/payline-sdk_)
-```
-composer config repositories.zip artifact extra/composer/artifact/zip
-composer require monext/module-payline:x.y.z
-```
+* Configuration
+    * Merchant ID
+    * Access key
+    * Environment
+        * Homologation for debug and test purpose.
+        * Production for real payment.
+
+![Screenshot showing payment method configuration common in backoffice](doc/config_common.png)
 
-Lancer la commande Magento pour activer le module
-```
-php -f bin/magento module:enable Monext_Payline
-php -f bin/magento setup:upgrade
-```
+* Cpt payment
+    * Enable
+    * Title
+    * Integration type
+    * Payment action
 
-Vérifier dans le dossier vendor que les dossiers sont bien présents et non vide
-- vendor/monext/module-payline
-- vendor/monext/payline-sdk
+![Screenshot showing payment method configuration cpt in backoffice](doc/config_cpt.png)
 
+* Cpt payment / Payline order status
 
-## Configuration
-*  Find Payline configuration menu under STORES > Settings > Configuration > SALES > Payment Methods > Payline
-*  Fill your Merchant ID and Access key under the "Common settings" section.
-*  Contracts are imported under the "Payline Contracts" section. The multi-select "Contracts" fied allows to choose which one will be visible on your store.
-*  "Payment solutions" section displays the "Payline - Web Payment Cpt" method configuration (more to come). You have to enable the solution and select your payment options and order status mapping in this section.
+![Screenshot showing payment method configuration status in backoffice](doc/config_cpt_status.png)
+
+* Contracts
+
+Contracts are imported under the "Payline Contracts" section.
+The multi-select "Contracts" fied allows to choose which one will be visible on your store.
+
+![Screenshot showing payment method configuration contract in backoffice](doc/config_contract.png)
+
+
+## Additional resources for developers
+
+To learn more about how the API used by the plugin and how to modify or use Magento 2 with it to fit your needs:
+* [Magento 2 Plugin Monext documentation](https://docs.monext.fr/display/DT/Magento+2+Plugin)
+* [Monext API documentation](https://api-docs.retail.monext.com/reference/getting-started-with-your-api)
+* [Magento 2 payments integratrions documentation](https://developer.adobe.com/commerce/php/development/payments-integrations/)
+
+## License
+
+This plugin's source code is completely free and released under the terms of the MIT license.
+
+## Contact and support
+
+If you want to contact us, the best way is through [this page on our website](https://www.monext.fr/gardons-le-contact) and send us your question(s).
+
+We guarantee that we answer as soon as we can!
+
+If you need support you can also directly check our FAQ section and contact us [on the support page](https://support.payline.com/hc/fr).