Skip to content

Commit 8dd7854

Browse files
authored
doc: Update README.md
1 parent 1b990b7 commit 8dd7854

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This is an rMQR Code image generator implemented in Python.
66
## Important Notice
77
Please verify an image generated by this software whether it can decode correctly before use.
88

9-
## Usage
9+
## Basic Usage
1010
```py
1111
from rmqrcode import rMQR
1212
import rmqrcode
@@ -31,6 +31,13 @@ The `fit_strategy` parameter is enum value of rmqrcode.FitStrategy to specify ho
3131
Here is an example of images genereated by each fit strategies for data `Test test test`:
3232
![Example of fit strategies](https://user-images.githubusercontent.com/14174940/172822478-4f2b5fb8-49bd-464f-b6b2-c7347f71cbf5.png)
3333

34+
## Advanced Usage
35+
### Select rMQR Code size manually
36+
To select rMQR Code size manually, use `rMQR()` constructor.
37+
```py
38+
qr = rMQR('R11x139', ErrorCorrectionLevel.H)
39+
qr.make("https://oudon.xyz")
40+
```
3441

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

0 commit comments

Comments
 (0)