Skip to content

Commit 0619d1c

Browse files
authored
Update README
Proof read document.
1 parent 5e35f6a commit 0619d1c

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

docs/en/README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Laravel will automiatcally pick up and install the package.
5252

5353
#### Print View
5454

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:
5656

5757
<div class="visible-print text-center">
5858
{!! QrCode::size(100)->generate(Request::url()); !!}
@@ -61,7 +61,7 @@ One of the main items that we use this package for is to have QrCodes in all of
6161

6262
#### Embed A QrCode
6363

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:
6565

6666
//Inside of a blade template.
6767
<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
113113

114114
#### Color `(int $red, int $green, int $blue, int $alpha = null)`
115115

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.
117117
118118
All colors must be expressed in RGBA (Red Green Blue Alpha). You can change the color of a QrCode by using the following:
119119

@@ -135,7 +135,7 @@ You can change the background color of a QrCode by calling the `backgroundColor`
135135

136136
You can apply a gradient to the QrCode by calling the `gradient` method.
137137

138-
The following gradient types are supported.
138+
The following gradient types are supported:
139139

140140
| Type | Example |
141141
| --- | --- |
@@ -147,7 +147,7 @@ The following gradient types are supported.
147147

148148
#### EyeColor `(int $eyeNumber, int $innerRed, int $innerGreen, int $innerBlue, int $outterRed = 0, int $outterGreen = 0, int $outterBlue = 0)`
149149

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:
151151

152152
| Eye Number | Example |
153153
| --- | --- |
@@ -158,7 +158,7 @@ You may change the eye colors by using the `eyeColor` method.
158158

159159
#### Style `(string $style, float $size = 0.5)`
160160

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:
162162

163163
| Style | Example |
164164
| --- | --- |
@@ -168,14 +168,14 @@ The style can be easily swapped out with `square.` `dot,` or `round.` This will
168168

169169
#### Eye Style `(string $style)`
170170

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:
172172

173173
| Style | Example |
174174
| --- | --- |
175175
| `sqaure` | ![Sqaure](../imgs/200-pixels.png) |
176176
| `circle` | ![Circle](../imgs/circle-eye.png)|
177177

178-
#### Margin Change
178+
#### Margin
179179

180180
The ability to change the margin around a QrCode is also supported. Simply specify the desired margin using the following syntax:
181181

@@ -187,7 +187,7 @@ Changing the level of error correction is easy. Just use the following syntax:
187187

188188
QrCode::errorCorrection('H');
189189

190-
The following are supported options for the `errorCorrection` method.
190+
The following are supported options for the `errorCorrection` method:
191191

192192
| Error Correction | Assurance Provided |
193193
| --- | --- |
@@ -196,7 +196,7 @@ The following are supported options for the `errorCorrection` method.
196196
| Q | 25% of codewords can be restored. |
197197
| H | 30% of codewords can be restored. |
198198

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).
200200
201201
#### Encoding
202202

@@ -289,7 +289,7 @@ Helpers are an easy way to create QrCodes that cause a reader to perform a certa
289289

290290
#### BitCoin
291291

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)
293293

294294
QrCode::BTC($address, $amount);
295295

@@ -305,7 +305,7 @@ This helpers generates a scannable bitcoin to send payments. [More information]
305305

306306
#### E-Mail
307307

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:
309309

310310
QrCode::email($to, $subject, $body);
311311

@@ -320,7 +320,7 @@ This helper generates an e-mail qrcode that is able to fill in the e-mail addres
320320

321321
#### Geo
322322

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.
324324

325325
QrCode::geo($latitude, $longitude);
326326

@@ -337,7 +337,7 @@ This helper generates a QrCode that can be scanned and then dials a number.
337337

338338
#### SMS (Text Messages)
339339

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:
341341

342342
QrCode::SMS($phoneNumber, $message);
343343

@@ -349,7 +349,7 @@ This helper makes SMS messages that can be prefilled with the send to address an
349349

350350
#### WiFi
351351

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:
353353

354354
QrCode::wiFi([
355355
'encryption' => 'WPA/WEP',

0 commit comments

Comments
 (0)