From 25534c63fba7367fdab438785ae3201ecc497b5f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tomasz=20Kali=C5=84ski?= <tomkalon@gmail.com>
Date: Wed, 11 Sep 2024 11:39:19 +0200
Subject: [PATCH] OP-533 - installation.md has been updated

---
 README.md           | 53 +++++++++++++++------------------------------
 doc/installation.md | 53 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 71 insertions(+), 35 deletions(-)
 create mode 100644 doc/installation.md

diff --git a/README.md b/README.md
index 8c21c7d..7d4f744 100644
--- a/README.md
+++ b/README.md
@@ -10,11 +10,11 @@ At BitBag we do believe in open source. However, we are able to do it just becau
 
 * [Support](#we-are-here-to-help)
 * [Installation](#installation)
-    * [Requirements](#requirements)
-    * [Usage](#usage)
-    * [Configuration](#configuration)
+  * [Requirements](#requirements)
+* [Usage](#usage)
+* [Configuration](#configuration)
 * [About us](#about-us)
-    * [Community](#community)
+  * [Community](#community)
 * [Additional Sylius resources for developers](#additional-resources-for-developers)
 * [License](#license)
 * [Contact](#contact)
@@ -26,49 +26,32 @@ This **open-source plugin was developed to help the Sylius community** and make
 
 [![](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_ing)
 
-# Installation
-----
+## Installation
 
+---
 ### Requirements
 
-We work on stable, supported, and up-to-date versions of packages. We recommend you do the same.
-
-| Package              | Version |
-|----------------------|---------|
-| PHP                  | ^8.1    |
-| sylius/sylius        | ^1.12   |
-----
-
-1. Require our plugin with composer:
-
-    ```bash
-    composer require bitbag/imoje-paywall-plugin --with-all-dependencies
-    ```
+We work on stable, supported and up-to-date versions of packages. We recommend you to do the same.
 
-2. Add plugin dependencies to your `config/bundles.php` file:
+| Package       | Version             |
+|---------------|---------------------|
+| PHP           | \>=8.1              |
+| sylius/sylius | \>=1.12.13 - 1.13.x |
+| MySQL         | \>= 5.7             |
+| NodeJS        | \>= 14.x            |
 
-    ```php
-    return [
-        ...
-        BitBag\SyliusImojePlugin\BitBagSyliusImojePlugin::class => ['all' => true],
-    ];
-    ```
-
-3. Import the routing in your `config/routes.yaml` file:
+----
 
-    ```yaml
-    # config/routes.yaml
+### Full installation guide
+- [See the full installation guide](doc/installation.md)
 
-    bitbag_sylius_imoje_plugin:
-      resource: "@BitBagSyliusImojePlugin/config/routing.yml"
-    ```
 
-### Usage
+## Usage
 
 This plugin allows you to use the payment solution delivered by Imoje.
 
 
-### Configuration:
+## Configuration:
 
 To create an ING-based payment method, go to Payment methods in the Sylius admin panel.
 After that, you need to add an ING payment:
diff --git a/doc/installation.md b/doc/installation.md
new file mode 100644
index 0000000..77b3a29
--- /dev/null
+++ b/doc/installation.md
@@ -0,0 +1,53 @@
+# 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.1              |
+| sylius/sylius | \>=1.12.13 - 1.13.x |
+| MySQL         | \>= 5.7             |
+| NodeJS        | \>= 14.x            |
+
+## Composer:
+```bash
+composer require bitbag/imoje-paywall-plugin --with-all-dependencies
+```
+
+## Basic configuration:
+Add plugin dependencies to your `config/bundles.php` file:
+
+```php
+# config/bundles.php
+
+return [
+    ...
+    BitBag\SyliusImojePlugin\BitBagSyliusImojePlugin::class => ['all' => true],
+];
+```
+
+Add routing to your `config/routes.yaml` file:
+```yaml
+# config/routes.yaml
+
+bitbag_sylius_imoje_plugin:
+    resource: "@BitBagSyliusImojePlugin/config/routing.yml"
+```
+
+## Known issues
+### Translations not displaying correctly
+For incorrectly displayed translations, execute the command:
+```bash
+bin/console cache:clear
+```