Merge pull request #22 from BitBagCommerce/OP-509

OP-509 - installation.md - new standard

README.md

@@ -42,39 +42,24 @@ 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_cms)
 
+## Installation
+---
+### Requirements
 
-## Instalation
-
-***
-
-Run composer to install DHL24ShippingExportPlugin:
-
-```bash
-$ composer require bitbag/dhl24-pl-shipping-export-plugin
-```
-
-Add plugin dependencies to your `config/bundles.php` file:
-```php
-return [
-    ...
+We work on stable, supported and up-to-date versions of packages. We recommend you to do the same.
 
-    BitBag\SyliusDhl24PlShippingExportPlugin\BitBagDhl24PlShippingExportPlugin::class => ['all' => true],
-];
-```
+| Package       | Version         |
+|---------------|-----------------|
+| PHP           | \>=8.0          |
+| sylius/sylius | 1.12.x - 1.13.x |
+| MySQL         | \>= 5.7         |
+| NodeJS        | \>= 18.x        |
 
-Add config file to your _sylius.yaml
+----
 
-```yaml
-imports:
-...
+### Full installation guide
+- [See the full installation guide](doc/installation.md)
 
-    - { resource: "@BitBagSyliusShippingExportPlugin/Resources/config/config.yml" }
-```
-Finish the installation by updating the database schema:
-```bash
-bin/console doctrine:migrations:diff
-bin/console doctrine:migrations:migrate
-```
 
 ## Customization
 

doc/installation.md

@@ -0,0 +1,72 @@
+# 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/dhl24-pl-shipping-export-plugin
+```
+
+## Basic configuration:
+Add plugin dependencies to your `config/bundles.php` file:
+
+```php
+# config/bundles.php
+
+return [
+    ...
+    BitBag\SyliusDhl24PlShippingExportPlugin\BitBagDhl24PlShippingExportPlugin::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" }
+```
+
+### 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
+```
+
+## Known issues
+### Translations not displaying correctly
+For incorrectly displayed translations, execute the command:
+```bash
+bin/console cache:clear
+```