ak/rxing
1
0
Fork 0
mirror of https://github.com/starovoid/rxing.git synced 2026-07-26 04:12:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

add features section to documentation

Browse Source
This commit is contained in:
Henry Schimke
2023-02-02 19:04:50 -06:00
parent 0ccb222b1a
commit 63d93afb2e
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -33,6 +33,18 @@ All barcode formats are tested and functioning in their current state against cu
| upc a | complete | | upc a | complete |
| upc e | complete | | upc e | complete |
## feature flags
The following feature flags are available:
* `image`: Enable features required for image manipulation and reading.
* `allow_forced_iso_ied_18004_compliance`: Allows the ability to force ISO/IED 18004 compliance. Leave disabled unless specificially needed.
* `svg_write`: Enable support for writing SVG files
* `svg_read`: Enable support for reading SVG files
* `wasm_support`: Make certain changes to support building this module in WASM
* `experimental_features`: Enable experimental features, risky.
* `serde`: Adds support for serde Serialize and Deserialize for outward facing structs
The default feature set includes only the `image` feature mentioned above.
## Incomplete ## Incomplete
The library has only been thurougly tested with the `BufferedImageLuminanceSource` source format. Using any other The library has only been thurougly tested with the `BufferedImageLuminanceSource` source format. Using any other
source is currently experimental and may result in unexpected or undefined outputs. This means that the feature flag source is currently experimental and may result in unexpected or undefined outputs. This means that the feature flag