Skip to content

Commit ef22789

Browse files
author
Corey McCormick
committed
Clearify facade statements
1 parent e52b412 commit ef22789

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

docs/en/README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,26 @@ Simple QrCode is an easy to use wrapper for the popular Laravel framework based
1717
<a id="docs-upgrade"></a>
1818
## Upgrade Guide
1919

20-
Upgrade from v2 by changing your `composer.json` file to `~3`
20+
Upgrade from v2 or v3 by changing your `composer.json` file to `~4`
2121

2222
You **must** install the `imagick` PHP extension if you plan on using the `png` image format.
2323

24+
#### v4
25+
26+
There was a Laravel facade issue within v3 that causes some loading issues. The only way to fix this was to create a backwards breaking change so v4 has been released. If you are coming from v2 there is no need to change any code. The below change only effects users on v3.
27+
28+
All references to the `QrCode` facade need to be changed to:
29+
30+
```
31+
use SimpleSoftwareIO\QrCode\Facades\QrCode;
32+
```
33+
2434
<a id="docs-configuration"></a>
2535
## Configuration
2636

2737
#### Composer
2838

29-
Run `composer require simplesoftwareio/simple-qrcode "~3"` to add the package.
39+
Run `composer require simplesoftwareio/simple-qrcode "~4"` to add the package.
3040

3141
Laravel will automiatcally pick up and install the package.
3242

@@ -54,8 +64,16 @@ You may embed a qrcode inside of an e-mail to allow your users to quickly scan.
5464

5565
#### Basic Usage
5666

67+
```
68+
// All examples below assume you are pulling in the QrCode facade with the following line of code. The Facade is auto-loaded for Laravel users.
69+
70+
use SimpleSoftwareIO\QrCode\Facades\QrCode;
71+
```
72+
5773
Using the QrCode Generator is very easy. The most basic syntax is:
5874

75+
use SimpleSoftwareIO\QrCode\Facades\QrCode;
76+
5977
QrCode::generate('Make me into a QrCode!');
6078

6179
This will make a QrCode that says "Make me into a QrCode!"

0 commit comments

Comments
 (0)