OP-502 - installation.md - new standard

README.md

@@ -48,43 +48,26 @@ If you are curious about the details of this plugin, read [this blog post](https
 
 ## Functionalities
 
-If you are curious about the details of this plugin and its finctionalities, check [this file](https://github.com/BitBagCommerce/SyliusShippingExportPlugin/blob/master/doc/functionalities.md).
+If you are curious about the details of this plugin and its functionalities, check [this file](https://github.com/BitBagCommerce/SyliusShippingExportPlugin/blob/master/doc/functionalities.md).
 
 ## Installation
 
-```bash
-composer require bitbag/shipping-export-plugin
-```
-
-Add plugin dependencies to your `config/bundles.php` file:
-
-```php
-return [
-    ...
-
-    BitBag\SyliusShippingExportPlugin\BitBagSyliusShippingExportPlugin::class => ['all' => true],
-];
-```
-
-Import required config in your `config/packages/_sylius.yaml` file:
-```yaml
-# config/packages/_sylius.yaml
-
-imports:
-    ...
+----
+### Requirements
 
-    - { resource: "@BitBagSyliusShippingExportPlugin/Resources/config/config.yml" }
-```
+We work on stable, supported and up-to-date versions of packages. We recommend you to do the same.
 
-Import routing in your config/routes.yaml file:
+| Package       | Version         |
+|---------------|-----------------|
+| PHP           | \>=8.0          |
+| sylius/sylius | 1.12.x - 1.13.x |
+| MySQL         | \>= 5.7         |
+| NodeJS        | \>= 18.x        |
 
-```yaml
-# config/routes.yaml
+----
 
-bitbag_shipping_export_plugin:
-    resource: "@BitBagSyliusShippingExportPlugin/Resources/config/routing.yml"
-    prefix: /admin
-```
+### Full installation guide
+- [See the full installation guide](doc/installation.md)
 
 ## Usage
 

doc/installation.md

@@ -0,0 +1,81 @@
+# 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/shipping-export-plugin
+```
+
+## Basic configuration:
+Add plugin dependencies to your `config/bundles.php` file:
+
+```php
+# config/bundles.php
+
+return [
+    ...
+    BitBag\SyliusShippingExportPlugin\BitBagSyliusShippingExportPlugin::class => ['all' => true],
+];
+```
+
+Import required config in your `config/packages/_sylius.yaml` file:
+
+```yaml
+# config/packages/_sylius.yaml
+
+imports:
+    ...
+    - { resource: "@BitBagSyliusShippingExportPlugin/Resources/config/config.yml" }
+```
+
+Import routing in your `config/routes.yaml` file:
+```yaml
+# config/routes.yaml
+
+bitbag_shipping_export_plugin:
+    resource: "@BitBagSyliusShippingExportPlugin/Resources/config/routing.yml"
+    prefix: /admin
+```
+
+### Update your database
+First, please run legacy-versioned migrations by using command:
+```bash
+bin/console doctrine:migrations:migrate
+```
+
+After migration, please create a new diff migration and update database:
+```bash
+bin/console doctrine:migrations:diff
+bin/console doctrine:migrations:migrate
+```
+### 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
+```