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: README.md
+19-7Lines changed: 19 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,17 +5,17 @@
5
5
This is an rMQR Code image generator implemented in Python. This is implemented based on [ISO/IEC 23941:2022](https://www.iso.org/standard/77404.html).
6
6
7
7
8
-
## Important Notice
8
+
## 📌 Important Notice
9
9
Please verify an image generated by this software whether it can decode correctly before use.
10
10
11
11
12
-
## Installation
12
+
## 🚀 Installation
13
13
```
14
14
pip install rmqrcode
15
15
```
16
16
17
17
18
-
## Basic Usage
18
+
## 📕 Basic Usage
19
19
### Generate rMQR Code
20
20
```py
21
21
from rmqrcode import rMQR
@@ -29,11 +29,11 @@ qr = rMQR.fit(
29
29
)
30
30
```
31
31
32
-
The `ecc` parameter is an enum value of rmqrcode.ErrorCorrectionLevel to select error correction level. The following values are available:
32
+
The `ecc` parameter is an enum value of `rmqrcode.ErrorCorrectionLevel` to select error correction level. The following values are available:
The `fit_strategy` parameter is enum value of rmqrcode.FitStrategy to specify how to determine size of rMQR Code. The following values are available:
36
+
The `fit_strategy` parameter is enum value of `rmqrcode.FitStrategy` to specify how to determine size of rMQR Code. The following values are available:
37
37
-**`FitStrategy.MINIMIZE_WIDTH`**: Try to minimize width.
38
38
-**`FitStrategy.MINIMIZE_HEIGHT`**: Try to minimize height.
39
39
-**`FitStrategy.BALANCED`**: Try to keep balance of width and height.
@@ -51,7 +51,7 @@ image.save("my_qr.png")
51
51
```
52
52
53
53
54
-
## Advanced Usage
54
+
## 📚 Advanced Usage
55
55
### Select rMQR Code size manually
56
56
To select rMQR Code size manually, use `rMQR()` constructor.
57
57
```py
@@ -62,7 +62,7 @@ qr.make("https://oudon.xyz")
62
62
`R11x139` means 11 rows and 139 columns. The following table shows available combinations.
63
63
64
64
||27|43|59|77|99|139|
65
-
|-|-|-|-|-|-|-|
65
+
|-|:-:|:-:|:-:|:-:|:-:|:-:|
66
66
|R7|❌|✅|✅|✅|✅|✅|
67
67
|R9|❌|✅|✅|✅|✅|✅|
68
68
|R11|✅|✅|✅|✅|✅|✅|
@@ -71,6 +71,18 @@ qr.make("https://oudon.xyz")
71
71
|R17|❌|✅|✅|✅|✅|✅|
72
72
73
73
74
+
## 🛠️ Under the Hood
75
+
### Encoding modes
76
+
77
+
The rMQR Code has the four encoding modes Numeric, Alphanumeric, Byte and Kanji to convert data efficiently. However, this package supoprts only Byte mode currently.
78
+
79
+
|Mode|Supported?|
80
+
|-|:-:|
81
+
|Numeric||
82
+
|Alphanumeric||
83
+
|Byte|✅|
84
+
|Kanji||
85
+
74
86
----
75
87
The word "QR Code" is registered trademark of DENSO WAVE Incorporated.<br>
0 commit comments