Skip to content

Commit eba2bc8

Browse files
authored
doc: Add example image of fit strategies to README
1 parent d01f245 commit eba2bc8

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,17 @@ qr = rMQR.fit(
2020
```
2121

2222
The `ecc` parameter is an enum value of rmqrcode.ErrorCollectionLevel to select error collection level. The following values are available:
23-
- `ErrorCollectionLevel.M`: Approx. 15% Recovery Capacity.
24-
- `ErrorCollectionLevel.H`: Approx. 30% Recovery Capacity.
23+
- **`ErrorCollectionLevel.M`**: Approx. 15% Recovery Capacity.
24+
- **`ErrorCollectionLevel.H`**: Approx. 30% Recovery Capacity.
2525

2626
The `fit_strategy` parameter is enum value of rmqrcode.FitStrategy to specify how to determine size of rMQR Code. The following values are available:
27-
- 'FitStrategy.MINIMIZE_WIDTH': Try to minimize width.
28-
- 'FitStrategy.MINIMIZE_HEIGHT': Try to minimize height.
29-
- 'FitStrategy.BALANCED': Try to keep balance of width and height.
27+
- **`FitStrategy.MINIMIZE_WIDTH`**: Try to minimize width.
28+
- **`FitStrategy.MINIMIZE_HEIGHT`**: Try to minimize height.
29+
- **`FitStrategy.BALANCED`**: Try to keep balance of width and height.
30+
31+
Here is an example of images genereated by each fit strategies for data `Test test test`:
32+
![Example of fit strategies](https://user-images.githubusercontent.com/14174940/172822478-4f2b5fb8-49bd-464f-b6b2-c7347f71cbf5.png)
33+
3034

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

0 commit comments

Comments
 (0)