Merge pull request #16 from BitBagCommerce/OP-533

OP-533 - installation.md - new standard
BitBagCommerce · Sep 16, 2024 · 02939d9 · 02939d9
2 parents 4c49f7d + 75844c7
commit 02939d9
Show file tree

Hide file tree

Showing 2 changed files with 63 additions and 35 deletions.
diff --git a/README.md b/README.md
@@ -55,45 +55,20 @@ We have a 70-person team of experts: business analysts and consultants, eCommerc
 * [Contact and support](#contact-and-support)
 * [Community](#community)
 
-
-
-
 # Installation
 ----
+The installation process for the Imoje Paywall Plugin can be found [here](doc/installation.md).
 
 ## 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
-    ```
-
-2. Add plugin dependencies to your `config/bundles.php` file:
-
-    ```php
-    return [
-        ...
-        BitBag\SyliusImojePlugin\BitBagSyliusImojePlugin::class => ['all' => true],
-    ];
-    ```
-
-3. Import the routing in your `config/routes.yaml` file:
-
-    ```yaml
-    # config/routes.yaml
-
-    bitbag_sylius_imoje_plugin:
-      resource: "@BitBagSyliusImojePlugin/config/routing.yml"
-    ```
+---
+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            |
 
 ## Usage
 

diff --git a/doc/installation.md 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
+```