Skip to content

Commit c4c4c47

Browse files
author
Corey McCormick
committed
Update docs
1 parent eea9d1c commit c4c4c47

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/en/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ You **must** install the `imagick` PHP extension if you plan on using the `png`
3333

3434
#### v4
3535

36+
> There was a mistake when creating 4.1.0 and allowing a backwards breaking change into the master branch. The `generate` method will now return an instance of `Illuminate\Support\HtmlString` if you are running Laravel. See https://github.com/SimpleSoftwareIO/simple-qrcode/issues/205 for more information.
37+
3638
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.
3739

3840
All references to the `QrCode` facade need to be changed to:
@@ -160,6 +162,8 @@ The following gradient types are supported:
160162

161163
You may change the eye colors by using the `eyeColor` method.
162164

165+
QrCode::eyeColor(0, 255, 255, 255, 0, 0, 0); // Changes the eye color of eye `0`
166+
163167
| Eye Number | Example |
164168
| --- | --- |
165169
| `0` | ![Eye 0](https://raw.githubusercontent.com/SimpleSoftwareIO/simple-qrcode/master/docs/imgs/eye-0.png?raw=true) |
@@ -171,6 +175,8 @@ You may change the eye colors by using the `eyeColor` method.
171175

172176
The style can be easily swapped out with `square`, `dot,` or `round`. This will change the blocks within the QrCode. The second parameter will affect the size of the dots or roundness.
173177

178+
QrCode::style('dot'); // Uses the `dot` style.
179+
174180
| Style | Example |
175181
| --- | --- |
176182
| `square` | ![Square](https://raw.githubusercontent.com/SimpleSoftwareIO/simple-qrcode/master/docs/imgs/200-pixels.png?raw=true) |
@@ -181,6 +187,8 @@ The style can be easily swapped out with `square`, `dot,` or `round`. This will
181187

182188
The eye within the QrCode supports two different styles, `square` and `circle`.
183189

190+
QrCode::eye('circle'); // Uses the `circle` style eye.
191+
184192
| Style | Example |
185193
| --- | --- |
186194
| `square` | ![Square](https://raw.githubusercontent.com/SimpleSoftwareIO/simple-qrcode/master/docs/imgs/200-pixels.png?raw=true) |

0 commit comments

Comments
 (0)