Skip to content

Commit

Permalink
Update of version and description about type number auto detection
Browse files Browse the repository at this point in the history
feature.
  • Loading branch information
kazuhikoarase committed Jul 24, 2017
1 parent 55998be commit 7b12048
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
16 changes: 8 additions & 8 deletions js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,18 @@ document.getElementById('placeHolder').innerHTML = qr.createImgTag();
#### qrcode(typeNumber, errorCorrectionLevel) => <code>QRCode</code>
Create a QRCode Object.

| Param | Type | Description |
| ---------------------| ------------------- | ------------------------------------------- |
| typeNumber | <code>number</code> | Type number (1 ~ 40) |
| errorCorrectionLevel | <code>string</code> | Error correction level ('L', 'M', 'Q', 'H') |
| Param | Type | Description |
| ---------------------| ------------------- | ---------------------------------------------- |
| typeNumber | <code>number</code> | Type number (1 ~ 40), or 0 for auto detection. |
| errorCorrectionLevel | <code>string</code> | Error correction level ('L', 'M', 'Q', 'H') |

#### qrcode.stringToBytes(s) : <code>number[]</code>
Encodes a string into an array of number(byte) using any charset.
This function is used by internal.
Overwrite this function to encode using a multibyte charset.

| Param | Type | Description |
| -------| ------------------- | ---------------- |
| ------ | ------------------- | ---------------- |
| s | <code>string</code> | string to encode |

### QRCode
Expand All @@ -48,7 +48,7 @@ Overwrite this function to encode using a multibyte charset.
Add a data to encode.

| Param | Type | Description |
| -------| ------------------- | ---------------------------------------------------------- |
| ------ | ------------------- | ---------------------------------------------------------- |
| data | <code>string</code> | string to encode |
| mode | <code>string</code> | Mode ('Numeric', 'Alphanumeric', 'Byte'(default), 'Kanji') |

Expand All @@ -64,7 +64,7 @@ The module at row and col is dark or not.
_[Note] call make() before this function._

| Param | Type | Description |
| ------| ------------------- | ------------------- |
| ----- | ------------------- | ------------------- |
| row | <code>number</code> | 0 ~ moduleCount - 1 |
| col | <code>number</code> | 0 ~ moduleCount - 1 |

Expand All @@ -75,7 +75,7 @@ Helper functions for HTML.
_[Note] call make() before these functions._

| Param | Type | Description |
| ---------| ------------------- | --------------------- |
| -------- | ------------------- | --------------------- |
| cellSize | <code>number</code> | default: 2 |
| margin | <code>number</code> | default: cellSize * 4 |

Expand Down
2 changes: 1 addition & 1 deletion js/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "qrcode-generator",
"version": "1.3.0",
"version": "1.3.1",
"description": "QR Code Generator implementation in JavaScript.",
"author": "Kazuhiko Arase",
"main": "qrcode.js",
Expand Down

0 comments on commit 7b12048

Please sign in to comment.