danvics/oxipng
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add default features note to readme (#528)

Browse source
This commit is contained in:
Josh Holmer 2023-07-05 00:44:06 -04:00 committed by GitHub
parent 129f1e6f76
commit d81236f71e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -115,6 +115,11 @@ method of usage involves creating an
passing it, along with an input filename, into the passing it, along with an input filename, into the
[optimize function](https://docs.rs/oxipng/3.0.1/oxipng/fn.optimize.html). [optimize function](https://docs.rs/oxipng/3.0.1/oxipng/fn.optimize.html).
It is recommended to disable the "binary" feature when including oxipng as a library. Currently, there is
no simple way to just disable one feature in Cargo, it has to be done by disabling default features
and specifying the desired ones, for example:
`oxipng = { version = "8.0", features = ["parallel", "zopfli", "filetime"], default-features = false }`
## History ## History
Oxipng began as a complete rewrite of the OptiPNG project, Oxipng began as a complete rewrite of the OptiPNG project,

5
README.template.md
View file

@ -75,6 +75,11 @@ method of usage involves creating an
passing it, along with an input filename, into the passing it, along with an input filename, into the
[optimize function](https://docs.rs/oxipng/3.0.1/oxipng/fn.optimize.html). [optimize function](https://docs.rs/oxipng/3.0.1/oxipng/fn.optimize.html).
It is recommended to disable the "binary" feature when including oxipng as a library. Currently, there is
no simple way to just disable one feature in Cargo, it has to be done by disabling default features
and specifying the desired ones, for example:
`oxipng = { version = "8.0", features = ["parallel", "zopfli", "filetime"], default-features = false }`
## History ## History
Oxipng began as a complete rewrite of the OptiPNG project, Oxipng began as a complete rewrite of the OptiPNG project,