Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Installation Guide #464

Merged
merged 1 commit into from
Dec 12, 2024
Merged

Improve Installation Guide #464

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@ From Administrator's point of view, every Refund request results in creating two

## Installation

#### Beware!

This installation instruction assumes that you're using Symfony Flex. If you don't, take a look at the
[legacy installation instruction](docs/legacy_installation.md). However, we strongly encourage you to use
Symfony Flex, it's much quicker!

1. Require plugin with composer:

```bash
Expand Down Expand Up @@ -68,12 +74,6 @@ From Administrator's point of view, every Refund request results in creating two
WKHTMLTOPDF_PATH=/usr/local/bin/wkhtmltopdf # Change this! :)
```

#### Beware!

This installation instruction assumes that you're using Symfony Flex. If you don't, take a look at the
[legacy installation instruction](docs/legacy_installation.md). However, we strongly encourage you to use
Symfony Flex, it's much quicker! :)

## Extension points

Refund Plugin is strongly based on both commands and events. Let's take RefundUnitsAction as an example. The whole
Expand Down
6 changes: 3 additions & 3 deletions docs/legacy_installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### Legacy installation (without SymfonyFlex)
### Legacy installation (without Symfony Flex)

1. Require plugin with composer:

Expand All @@ -10,8 +10,8 @@

```php
$bundles = [
new \Knp\Bundle\SnappyBundle\KnpSnappyBundle(),
new \Sylius\RefundPlugin\SyliusRefundPlugin(),
Knp\Bundle\SnappyBundle\KnpSnappyBundle::class => ['all' => true],
Sylius\RefundPlugin\SyliusRefundPlugin::class => ['all' => true],
];
```

Expand Down
Loading