Merge pull request #2 from WeGetFinancing/GET-1761-doc

updated plugin documentation
WeGetFinancing · Nov 8, 2022 · e9ae7c7 · e9ae7c7
2 parents 5b6983c + e3d9b1e
commit e9ae7c7
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 This is a Magento 2 module which integrates WeGetFinancing payment gateway with the Magento 2 application.
 
-## Getting Started
+## Installation 
 
 In order to install the module, please use the composer package manager.
 
@@ -28,4 +28,25 @@ In order to install the module, please use the composer package manager.
     php -d memory_limit=-1 bin/magento setup:di:compile
     ```
 
+## Update
 
+To update the module follow those steps:
+
+1. From your magento project directory, make a copy of the configuration file
+   ```
+   cp vendor/wegetfinancing/magento-checkout-plugin/etc/config.xml ./config.xml.wgf.checkout.tmp
+   ```
+2. Update your plugin
+   ```
+   composer update
+   ```
+3. Put back your configuration file
+   ```
+   cp config.xml.wgf.checkout.tmp vendor/wegetfinancing/magento-checkout-plugin/etc/config.xml 
+   ```
+4. Complete the upgrade, flush the cache and rebuild the dic
+    ```
+    php -d memory_limit=-1 bin/magento setup:upgrade
+    php -d memory_limit=-1 bin/magento cache:flush
+    php -d memory_limit=-1 bin/magento setup:di:compile
+    ```
diff --git a/composer.json b/composer.json
@@ -13,7 +13,7 @@
         "wegetfinancing/php-sdk": "1.*"
     },
     "type": "magento2-module",
-    "version": "0.1.2",
+    "version": "0.1.3",
     "autoload": {
         "files": [
             "registration.php"

diff --git a/etc/module.xml b/etc/module.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
-    <module name="WeGetFinancing_Checkout" setup_version="0.1.2">
+    <module name="WeGetFinancing_Checkout" setup_version="0.1.3">
         <sequence>
             <module name="Magento_Sales" />
             <module name="Magento_Payment" />