Skip to content

Commit 4382b87

Browse files
committed
Improve wording in the documentation
1 parent 8600d23 commit 4382b87

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -196,9 +196,10 @@ QRCode.toDataURL('some text', { errorCorrectionLevel: 'H' }, function (err, url)
196196
Capacity depends on symbol version and error correction level. Also encoding modes may influence the amount of storable data.
197197

198198
The QR Code versions range from version **1** to version **40**.
199-
Each version has a different number of modules (black and white dots), which define the symbol's size.
200-
For version 1 they are `21x21`, for version 2 `25x25` e so on.
201-
Higher is the version, more are the storable data, and of course bigger will be the QR Code symbol.
199+
Each version has a different number of modules (black and white dots), which define size of the symbol.
200+
For version 1 symbol size is `21x21` modules, for version 2 `25x25` and so on up to `177x177` modules
201+
for the largest symbol size.
202+
The higher the version, the more data can be stored in the QR code and of course the bigger the symbol will be.
202203

203204
The table below shows the maximum number of storable characters in each encoding mode and for each error correction level.
204205

@@ -212,7 +213,7 @@ The table below shows the maximum number of storable characters in each encoding
212213
**Note:** Maximum characters number can be different when using [Mixed modes](#mixed-modes).
213214

214215
QR Code version can be set through `options.version` property.
215-
If no version is specified, the more suitable value will be used. Unless a specific version is required, this option is not needed.
216+
If no version is specified, the most suitable value will be used. Unless a specific version is required, this option is not needed.
216217

217218
```javascript
218219
QRCode.toDataURL('some text', { version: 2 }, function (err, url) {
@@ -222,7 +223,7 @@ QRCode.toDataURL('some text', { version: 2 }, function (err, url) {
222223

223224
## Encoding modes
224225
Modes can be used to encode a string in a more efficient way.
225-
A mode may be more suitable than others depending on the string content.
226+
A mode may be more suitable than the others depending on the data content.
226227
A list of supported modes are shown in the table below:
227228

228229
| Mode | Characters | Compression |
@@ -232,8 +233,8 @@ A list of supported modes are shown in the table below:
232233
| Kanji | Characters from the Shift JIS system based on JIS X 0208 | 2 kanji are represented by 13 bits |
233234
| Byte | Characters from the ISO/IEC 8859-1 character set | Each characters are represented by 8 bits |
234235

235-
Choose the right mode may be tricky if the input text is unknown.
236-
In these cases **Byte** mode is the best choice since all characters can be encoded with it. (See [Multibyte characters](#multibyte-characters))
236+
Choosing the right mode may be tricky if the input text is unknown.
237+
In these cases **Byte** mode is the best choice since all characters can be encoded with it (see [Multibyte characters](#multibyte-characters)).
237238
However, if the QR Code reader supports mixed modes, using [Auto mode](#auto-mode) may produce better results.
238239

239240
### Mixed modes

0 commit comments

Comments
 (0)