Merge pull request #71 from BitBagCommerce/OP-497

OP-497 - installation.md - new standard

README.md

@@ -41,24 +41,29 @@ This **open-source plugin was developed to help the Sylius community**. If you h
 
 [![](https://bitbag.io/wp-content/uploads/2020/10/button-contact.png)](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_payu)
 
-# Functionalities
+## Functionalities
 
 All main functionalities of the plugin are described [here.](https://github.com/BitBagCommerce/SyliusPayUPlugin/blob/master/doc/functionalities.md)
 
-# Installation
+## Installation
 ---
 
-```bash
-$ composer require bitbag/payu-plugin
-```
-
-Add plugin dependencies to your config/bundles.php file:
+### 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        | 14.x            |
+
+----
+
+### Full installation guide
+- [See the full installation guide](doc/installation.md)
 
-```php
-return [
-    BitBag\SyliusPayUPlugin\BitBagSyliusPayUPlugin::class => ['all' => true],
-]
-```
 ## Customization
 ----
 

doc/installation.md

@@ -0,0 +1,55 @@
+# Installation
+
+## Overview:
+GENERAL
+<!------------------------------------------------------------------
+Downloading the plugin
+Importing or modifying config files, adding routes, parameters, services etc.
+-------------------------------------------------------------------->
+- [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        | 14.x            |
+
+## Composer:
+```bash
+composer require bitbag/payu-plugin
+```
+
+## Basic configuration:
+Add plugin dependencies to your `config/bundles.php` file:
+
+```php
+# config/bundles.php
+
+return [
+    ...
+    BitBag\SyliusPayUPlugin\BitBagSyliusPayUPlugin::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.
+
+## Known issues
+### Translations not displaying correctly
+For incorrectly displayed translations, execute the command:
+```bash
+bin/console cache:clear
+```