diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 993cb7a..592d167 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -25,10 +25,7 @@ jobs: sylius: [~1.12.0, ~1.13.0] node: [^14.17.x] mysql: [5.7, 8.0] - - exclude: - - sylius: ~1.11.0 - symfony: ^6.0 + env: APP_ENV: test DATABASE_URL: "mysql://root:root@127.0.0.1/sylius?serverVersion=${{ matrix.mysql }}" diff --git a/README.md b/README.md index 0f2d6c1..51126a4 100644 --- a/README.md +++ b/README.md @@ -41,25 +41,27 @@ 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_przelewy24) -# Functionalities +## Functionalities All main functionalities of the plugin are described [here.](https://github.com/BitBagCommerce/SyliusPrzelewy24Plugin/blob/master/doc/functionalities.md) ## Installation +--- +### Requirements -``` -$ composer require bitbag/przelewy24-plugin -``` +We work on stable, supported and up-to-date versions of packages. We recommend you to do the same. -Add plugin dependencies to your `config/bundles.php` file: +| Package | Version | +|---------------|-----------------| +| PHP | \>=8.0 | +| sylius/sylius | 1.12.x - 1.13.x | +| MySQL | \>= 5.7 | +| NodeJS | \>= 14.17.x | -```php -return [ - ... +---- - BitBag\SyliusPrzelewy24Plugin\BitBagSyliusPrzelewy24Plugin::class => ['all' => true], -]; -``` +### Full installation guide +- [See the full installation guide](doc/installation.md) ## Customization ---- diff --git a/doc/installation.md b/doc/installation.md new file mode 100644 index 0000000..7dce541 --- /dev/null +++ b/doc/installation.md @@ -0,0 +1,45 @@ +# 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 | \>= 14.17.x | + +## Composer: +```bash +composer require bitbag/przelewy24-plugin +``` + +## Basic configuration: +Add plugin dependencies to your `config/bundles.php` file: + +```php +# config/bundles.php + +return [ + ... + BitBag\SyliusPrzelewy24Plugin\BitBagSyliusPrzelewy24Plugin::class => ['all' => true], +]; +``` + +## Known issues +### Translations not displaying correctly +For incorrectly displayed translations, execute the command: +```bash +bin/console cache:clear +```