Merge pull request #10 from BitBagCommerce/OP-535

OP-535 - installation.md - new standard

README.md

@@ -46,8 +46,8 @@ We have a 70-person team of experts: business analysts and consultants, eCommerc
 ---
 * [Overview](#overview)
 * [Installation](#installation)
-  * [Customization](#customization)
-  * [Testing](#testing)
+* [Customization](#customization)
+* [Testing](#testing)
 * [Functionalities](#functionalities)
 * [Demo](#demo)
 * [Additional resources for developers](#additional-resources-for-developers)
@@ -62,31 +62,23 @@ We have a 70-person team of experts: business analysts and consultants, eCommerc
 The Braintree Plugin seamlessly integrates the Braintree payment gateway into your Sylius eCommerce platform, enabling a straightforward and secure shopping experience for your customers. As an open-source addition to the Sylius ecosystem, this plugin brings together the comprehensive features of both Sylius and Braintree, facilitating not only payment processing but also order refunds.
 
 
+## Installation
 
-
-# Installation
 ---
+### Requirements
 
-```bash
-$ composer require bitbag/braintree-plugin 
-```
-
-Add plugin dependencies to your config/bundles.php file:
+We work on stable, supported and up-to-date versions of packages. We recommend you to do the same.
 
-```php
-return [
-   BitBag\SyliusBraintreePlugin\BitBagSyliusBraintreePlugin::class => ['all' => true]
-];
-```
-
-Import configuration:
+| Package       | Version         |
+|---------------|-----------------|
+| PHP           | \>=8.0          |
+| sylius/sylius | 1.12.x - 1.13.x |
+| MySQL         | \>= 5.7         |
+| NodeJS        | \>= 18.x        |
+----
 
-```yaml
-imports:
-    ...
-
-    - { resource: "@BitBagSyliusBraintreePlugin/Resources/config/config.yml" }
-```
+### Full installation guide
+- [See the full installation guide](doc/installation.md)
 
 ## Customization
 ----

doc/installation.md

@@ -0,0 +1,55 @@
+# Installation
+
+## Overview:
+GENERAL
+- [Requirements](#requirements)
+- [Composer](#composer)
+- [Basic configuration](#basic-configuration)
+---
+ADDITIONAL
+- [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         |
+| NodeJS        | \>= 18.x        |
+
+## Composer:
+```bash
+composer require bitbag/braintree-plugin 
+```
+
+## Basic configuration:
+Add plugin dependencies to your `config/bundles.php` file:
+
+```php
+# config/bundles.php
+
+return [
+    //...
+    BitBag\SyliusBraintreePlugin\BitBagSyliusBraintreePlugin::class => ['all' => true]
+];
+```
+
+Import required config in your `config/packages/_sylius.yaml` file:
+
+```yaml
+# config/packages/_sylius.yaml
+
+imports:
+    #...
+    - { resource: "@BitBagSyliusBraintreePlugin/Resources/config/config.yml" }
+```
+
+## Known issues
+### Translations not displaying correctly
+For incorrectly displayed translations, execute the command:
+```bash
+bin/console cache:clear
+```