Merge pull request #33 from BitBagCommerce/OP-534

OP-534 - added installation.md - new standard

.github/workflows/build.yml

@@ -21,16 +21,16 @@ jobs:
             matrix:
                 php: [ "8.0", "8.1", "8.2", "8.3" ]
                 symfony: [ "^5.4", "^6.4" ]
-                sylius: [ "^1.12", "^1.13" ]
+                sylius: [ "~1.12.0", "~1.13.0" ]
                 node: [ "18.x", "20.x" ]
                 mysql: [ "8.0" ]
-
+                
                 exclude:
-                    - sylius: ^1.13
-                      php: 8.0
-                    - sylius: ^1.12
-                      php: 8.0
-                      symfony: ^6.4
+                    - sylius: "~1.13.0"
+                      php: "8.0"
+                    - sylius: "~1.12.0"
+                      php: "8.0"
+                      symfony: "^6.4"
 
         env:
             APP_ENV: test

README.md

@@ -48,7 +48,6 @@ We have a 70-person team of experts: business analysts and eCommerce consultants
 * [Functionalities](doc/functionalities.md)
 * [Installation](#installation)
   * [Requirements](#requirements)
-* [Testing](#testing)
 * [Usage](#usage)
 * [Demo](#demo)
 * [Additional resources for developers](#additional-resources-for-developers)
@@ -61,49 +60,20 @@ We have a 70-person team of experts: business analysts and eCommerce consultants
 Unlock seamless payment processing with the BNPParibasPayments Plugin for Sylius. This open-source marvel is your key to effortlessly integrating the Mercanet BNP Paribas payment system into your Sylius platform app. We've got your back every step of the way.
 
 # Installation
-----
-## Requirements
-----
-We work on stable, supported, and up-to-date versions of packages. We recommend you do the same.
+The installation process for the `SyliusMercanetBnpParibasPlugin` can be found [here](doc/installation.md).
 
-| Package | Version | Version |
-| --- |-------|-------|
-| PHP | ^8.0  | ^8.1  |
-| Sylius | ^1.12 | ^1.13 |
+---
+## Requirements
 
-----
+We work on stable, supported and up-to-date versions of packages. We recommend you to do the same.
 
-```bash
-$ composer require bitbag/mercanet-bnp-paribas-plugin
-```
-
-Add plugin dependencies to your AppKernel.php file:
-```php
-public function registerBundles()
-{
-    return array_merge(parent::registerBundles(), [
-        ...
-
-        new \BitBag\MercanetBnpParibasPlugin\BitBagMercanetBnpParibasPlugin(),
-    ]);
-}
-```
-
-## Testing
-----
+| Package       | Version         |
+|---------------|-----------------|
+| PHP           | \>=8.0          |
+| sylius/sylius | 1.12.x - 1.13.x |
+| MySQL         | \>= 5.7         |
 
-```bash
-$ wget http://getcomposer.org/composer.phar
-$ php composer.phar install
-$ yarn install
-$ yarn run gulp
-$ php bin/console sylius:install --env test
-$ php bin/console server:start --env test
-$ open http://localhost:8000
-$ bin/behat features/*
-$ bin/phpspec run
-```
-## Usage
+# Usage
 ----
 
 Go to the payment methods in your admin panel. Now you should be able to add new payment method for Mercanet BNP Paribas gateway.

composer.json

@@ -15,7 +15,7 @@
     ],
     "require": {
         "php": "^8.0",
-        "sylius/sylius": "^1.12 || ^1.13",
+        "sylius/sylius": "~1.12.0 || ~1.13.0",
         "symfony/webpack-encore-bundle": "^1.16"
     },
     "require-dev": {

doc/installation.md

@@ -0,0 +1,65 @@
+# Installation
+
+## Overview:
+GENERAL
+- [Requirements](#requirements)
+- [Composer](#composer)
+- [Basic configuration](#basic-configuration)
+---
+ADDITIONAL
+- [Tests](#tests)
+- [Known Issues](#known-issues)
+---
+
+## Requirements:
+We work on stable, supported and up-to-date versions of packages. We recommend you to do the same.
+
+| Package       | Version         |
+|---------------|-----------------|
+| PHP           | \>=8.0          |
+| sylius/sylius | 1.12.x - 1.13.x |
+| MySQL         | \>= 5.7         |
+
+## Composer:
+```bash
+composer require bitbag/mercanet-bnp-paribas-plugin
+```
+
+## Basic configuration:
+Add plugin dependencies to your `config/bundles.php` file:
+
+```php
+# config/bundles.php
+
+return [
+    ...
+    BitBag\MercanetBnpParibasPlugin\BitBagMercanetBnpParibasPlugin::class => ['all' => true],
+];
+```
+
+### Clear application cache by using command:
+```bash
+bin/console cache:clear
+```
+**Note:** If you are running it on production, add the `-e prod` flag to this command.
+
+## Tests
+To run the tests, execute the commands:
+```bash
+$ wget http://getcomposer.org/composer.phar
+$ php composer.phar install
+$ yarn install
+$ yarn run gulp
+$ php bin/console sylius:install --env test
+$ php bin/console server:start --env test
+$ open http://localhost:8000
+$ bin/behat features/*
+$ bin/phpspec run
+```
+
+## Known issues
+### Translations not displaying correctly
+For incorrectly displayed translations, execute the command:
+```bash
+bin/console cache:clear
+```