You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/README.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,7 @@ Laravel will automiatcally pick up and install the package.
52
52
53
53
#### Print View
54
54
55
-
One of the main items that we use this package for is to have QrCodes in all of our print views. This allows our customers to return to the original page after it is printed by simply scanning the code. We achieved this by adding the following into our footer.blade.php file.
55
+
One of the main items that we use this package for is to have QrCodes in all of our print views. This allows our customers to return to the original page after it is printed by simply scanning the code. We achieved this by adding the following into our footer.blade.php file:
@@ -61,7 +61,7 @@ One of the main items that we use this package for is to have QrCodes in all of
61
61
62
62
#### Embed A QrCode
63
63
64
-
You may embed a qrcode inside of an e-mail to allow your users to quickly scan. The following is an example of how to do this with Laravel.
64
+
You may embed a qrcode inside of an e-mail to allow your users to quickly scan. The following is an example of how to do this with Laravel:
65
65
66
66
//Inside of a blade template.
67
67
<img src="{!!$message->embedData(QrCode::format('png')->generate('Embed me into an e-mail!'), 'QrCode.png', 'image/png')!!}">
@@ -113,7 +113,7 @@ You can change the size of a QrCode by using the `size` method. Simply specify t
113
113
114
114
#### Color `(int $red, int $green, int $blue, int $alpha = null)`
115
115
116
-
>Be careful when changing the color of a QrCode. Some readers have a very difficult time reading QrCodes in color.
116
+
>Be careful when changing the color of a QrCode, as some readers have a very difficult time reading QrCodes in color.
117
117
118
118
All colors must be expressed in RGBA (Red Green Blue Alpha). You can change the color of a QrCode by using the following:
119
119
@@ -135,7 +135,7 @@ You can change the background color of a QrCode by calling the `backgroundColor`
135
135
136
136
You can apply a gradient to the QrCode by calling the `gradient` method.
137
137
138
-
The following gradient types are supported.
138
+
The following gradient types are supported:
139
139
140
140
| Type | Example |
141
141
| --- | --- |
@@ -147,7 +147,7 @@ The following gradient types are supported.
147
147
148
148
#### EyeColor `(int $eyeNumber, int $innerRed, int $innerGreen, int $innerBlue, int $outterRed = 0, int $outterGreen = 0, int $outterBlue = 0)`
149
149
150
-
You may change the eye colors by using the `eyeColor` method.
150
+
You may change the eye colors by using the `eyeColor` method. Example:
151
151
152
152
| Eye Number | Example |
153
153
| --- | --- |
@@ -158,7 +158,7 @@ You may change the eye colors by using the `eyeColor` method.
158
158
159
159
#### Style `(string $style, float $size = 0.5)`
160
160
161
-
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.
161
+
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. Example:
162
162
163
163
| Style | Example |
164
164
| --- | --- |
@@ -168,14 +168,14 @@ The style can be easily swapped out with `square.` `dot,` or `round.` This will
168
168
169
169
#### Eye Style `(string $style)`
170
170
171
-
The eye within the QrCode supports two different styles, `dot` and `circle.`
171
+
The eye within the QrCode supports two different styles, `dot` and `circle.` Example:
172
172
173
173
| Style | Example |
174
174
| --- | --- |
175
175
|`sqaure`||
176
176
|`circle`||
177
177
178
-
#### Margin Change
178
+
#### Margin
179
179
180
180
The ability to change the margin around a QrCode is also supported. Simply specify the desired margin using the following syntax:
181
181
@@ -187,7 +187,7 @@ Changing the level of error correction is easy. Just use the following syntax:
187
187
188
188
QrCode::errorCorrection('H');
189
189
190
-
The following are supported options for the `errorCorrection` method.
190
+
The following are supported options for the `errorCorrection` method:
191
191
192
192
| Error Correction | Assurance Provided |
193
193
| --- | --- |
@@ -196,7 +196,7 @@ The following are supported options for the `errorCorrection` method.
196
196
| Q | 25% of codewords can be restored. |
197
197
| H | 30% of codewords can be restored. |
198
198
199
-
>The more error correction used; the bigger the QrCode becomes and the less data it can store. Read more about [error correction](http://en.wikipedia.org/wiki/QR_code#Error_correction).
199
+
>The more error corrections used; the bigger the QrCode becomes and the less data it can store. Read more about [error correction](http://en.wikipedia.org/wiki/QR_code#Error_correction).
200
200
201
201
#### Encoding
202
202
@@ -289,7 +289,7 @@ Helpers are an easy way to create QrCodes that cause a reader to perform a certa
289
289
290
290
#### BitCoin
291
291
292
-
This helpers generates a scannable bitcoin to send payments. [More information](https://bitco.in/en/developer-guide#plain-text)
292
+
This helper generates a scannable bitcoin to send payments. [More information](https://bitco.in/en/developer-guide#plain-text)
293
293
294
294
QrCode::BTC($address, $amount);
295
295
@@ -305,7 +305,7 @@ This helpers generates a scannable bitcoin to send payments. [More information]
305
305
306
306
#### E-Mail
307
307
308
-
This helper generates an e-mail qrcode that is able to fill in the e-mail address, subject, and body.
308
+
This helper generates an e-mail qrcode that is able to fill in the e-mail address, subject, and body:
309
309
310
310
QrCode::email($to, $subject, $body);
311
311
@@ -320,7 +320,7 @@ This helper generates an e-mail qrcode that is able to fill in the e-mail addres
320
320
321
321
#### Geo
322
322
323
-
This helper generates a latitude and longitude that a phone can read and open the location up in Google Maps or similar app.
323
+
This helper generates a latitude and longitude that a phone can read and opens the location in Google Maps or similar app.
324
324
325
325
QrCode::geo($latitude, $longitude);
326
326
@@ -337,7 +337,7 @@ This helper generates a QrCode that can be scanned and then dials a number.
337
337
338
338
#### SMS (Text Messages)
339
339
340
-
This helper makes SMS messages that can be prefilled with the send to address and body of the message.
340
+
This helper makes SMS messages that can be prefilled with the send to address and body of the message:
341
341
342
342
QrCode::SMS($phoneNumber, $message);
343
343
@@ -349,7 +349,7 @@ This helper makes SMS messages that can be prefilled with the send to address an
349
349
350
350
#### WiFi
351
351
352
-
This helpers makes scannable QrCodes that can connect a phone to a WiFI network.
352
+
This helpers makes scannable QrCodes that can connect a phone to a WiFI network:
0 commit comments