Skip to content

Commit e9d6002

Browse files
authored
doc: update README.md
1 parent 5ed090c commit e9d6002

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@
55
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).
66

77

8-
## Important Notice
8+
## 📌 Important Notice
99
Please verify an image generated by this software whether it can decode correctly before use.
1010

1111

12-
## Installation
12+
## 🚀 Installation
1313
```
1414
pip install rmqrcode
1515
```
1616

1717

18-
## Basic Usage
18+
## 📕 Basic Usage
1919
### Generate rMQR Code
2020
```py
2121
from rmqrcode import rMQR
@@ -29,11 +29,11 @@ qr = rMQR.fit(
2929
)
3030
```
3131

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:
3333
- **`ErrorCorrectionLevel.M`**: Approx. 15% Recovery Capacity.
3434
- **`ErrorCorrectionLevel.H`**: Approx. 30% Recovery Capacity.
3535

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:
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:
3737
- **`FitStrategy.MINIMIZE_WIDTH`**: Try to minimize width.
3838
- **`FitStrategy.MINIMIZE_HEIGHT`**: Try to minimize height.
3939
- **`FitStrategy.BALANCED`**: Try to keep balance of width and height.
@@ -51,7 +51,7 @@ image.save("my_qr.png")
5151
```
5252

5353

54-
## Advanced Usage
54+
## 📚 Advanced Usage
5555
### Select rMQR Code size manually
5656
To select rMQR Code size manually, use `rMQR()` constructor.
5757
```py
@@ -62,7 +62,7 @@ qr.make("https://oudon.xyz")
6262
`R11x139` means 11 rows and 139 columns. The following table shows available combinations.
6363

6464
| |27|43|59|77|99|139|
65-
|-|-|-|-|-|-|-|
65+
|-|:-:|:-:|:-:|:-:|:-:|:-:|
6666
|R7|||||||
6767
|R9|||||||
6868
|R11|||||||
@@ -71,6 +71,18 @@ qr.make("https://oudon.xyz")
7171
|R17|||||||
7272

7373

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+
7486
----
7587
The word "QR Code" is registered trademark of DENSO WAVE Incorporated.<br>
7688
http://www.denso-wave.com/qrcode/faqpatent-e.html

0 commit comments

Comments
 (0)