Skip to content

Commit 7f81e3b

Browse files
committed
doc: Add usage of CLI to README.md
1 parent 73554a8 commit 7f81e3b

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,30 @@ pip install rmqrcode
1616

1717

1818
## 📕 Basic Usage
19+
### CLI
20+
Generate an rMQR Code image from your command line, use `rmqr` command:
21+
```sh
22+
rmqr 'Text data' 'my_qr.png'
23+
```
24+
25+
See the help to list the options:
26+
```sh
27+
➜ rmqr -h
28+
usage: rmqr [-h] [--ecc {M,H}] [--version VERSION] [--fit-strategy {min_width,min_height,balanced}]
29+
DATA OUTPUT
30+
31+
positional arguments:
32+
DATA Data to encode.
33+
OUTPUT Output file path
34+
35+
optional arguments:
36+
-h, --help show this help message and exit
37+
--ecc {M,H} Error correction level. (default: M)
38+
--version VERSION rMQR Code version like 'R11x139'.
39+
--fit-strategy {min_width,min_height,balanced}
40+
Strategy how to determine rMQR Code size.
41+
```
42+
1943
### Generate rMQR Code
2044
```py
2145
from rmqrcode import rMQR
@@ -60,7 +84,7 @@ qr.make("https://oudon.xyz")
6084
```
6185

6286
`R11x139` means 11 rows and 139 columns. The following table shows available combinations.
63-
87+
6488
| |27|43|59|77|99|139|
6589
|-|:-:|:-:|:-:|:-:|:-:|:-:|
6690
|R7|||||||

0 commit comments

Comments
 (0)