Skip to content

Commit 5ed090c

Browse files
authored
doc: Update README.md
1 parent ca65cfc commit 5ed090c

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ pip install rmqrcode
1616

1717

1818
## Basic Usage
19+
### Generate rMQR Code
1920
```py
2021
from rmqrcode import rMQR
2122
import rmqrcode
@@ -40,6 +41,15 @@ The `fit_strategy` parameter is enum value of rmqrcode.FitStrategy to specify ho
4041
Here is an example of images genereated by each fit strategies for data `Test test test`:
4142
![Example of fit strategies](https://user-images.githubusercontent.com/14174940/172822478-4f2b5fb8-49bd-464f-b6b2-c7347f71cbf5.png)
4243

44+
### Save as image
45+
```py
46+
from rmqrcode import QRImage
47+
48+
image = QRImage(qr, module_size=8)
49+
image.show()
50+
image.save("my_qr.png")
51+
```
52+
4353

4454
## Advanced Usage
4555
### Select rMQR Code size manually
@@ -49,6 +59,17 @@ qr = rMQR('R11x139', ErrorCorrectionLevel.H)
4959
qr.make("https://oudon.xyz")
5060
```
5161

62+
`R11x139` means 11 rows and 139 columns. The following table shows available combinations.
63+
64+
| |27|43|59|77|99|139|
65+
|-|-|-|-|-|-|-|
66+
|R7|||||||
67+
|R9|||||||
68+
|R11|||||||
69+
|R13|||||||
70+
|R15|||||||
71+
|R17|||||||
72+
5273

5374
----
5475
The word "QR Code" is registered trademark of DENSO WAVE Incorporated.<br>

0 commit comments

Comments
 (0)