Skip to content

Commit d81236f

Browse files
authored
Add default features note to readme (oxipng#528)
1 parent 129f1e6 commit d81236f

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,11 @@ method of usage involves creating an
115115
passing it, along with an input filename, into the
116116
[optimize function](https://docs.rs/oxipng/3.0.1/oxipng/fn.optimize.html).
117117

118+
It is recommended to disable the "binary" feature when including oxipng as a library. Currently, there is
119+
no simple way to just disable one feature in Cargo, it has to be done by disabling default features
120+
and specifying the desired ones, for example:
121+
`oxipng = { version = "8.0", features = ["parallel", "zopfli", "filetime"], default-features = false }`
122+
118123
## History
119124

120125
Oxipng began as a complete rewrite of the OptiPNG project,

README.template.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,11 @@ method of usage involves creating an
7575
passing it, along with an input filename, into the
7676
[optimize function](https://docs.rs/oxipng/3.0.1/oxipng/fn.optimize.html).
7777

78+
It is recommended to disable the "binary" feature when including oxipng as a library. Currently, there is
79+
no simple way to just disable one feature in Cargo, it has to be done by disabling default features
80+
and specifying the desired ones, for example:
81+
`oxipng = { version = "8.0", features = ["parallel", "zopfli", "filetime"], default-features = false }`
82+
7883
## History
7984

8085
Oxipng began as a complete rewrite of the OptiPNG project,

0 commit comments

Comments
 (0)