From d81236f71e47e9ed11f6d300095b3ba5f52f173c Mon Sep 17 00:00:00 2001 From: Josh Holmer Date: Wed, 5 Jul 2023 00:44:06 -0400 Subject: [PATCH] Add default features note to readme (#528) --- README.md | 5 +++++ README.template.md | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/README.md b/README.md index d2e7262e..04189a9c 100644 --- a/README.md +++ b/README.md @@ -115,6 +115,11 @@ method of usage involves creating an passing it, along with an input filename, into the [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 Oxipng began as a complete rewrite of the OptiPNG project, diff --git a/README.template.md b/README.template.md index 265e9f9b..6f14ed8d 100644 --- a/README.template.md +++ b/README.template.md @@ -75,6 +75,11 @@ method of usage involves creating an passing it, along with an input filename, into the [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 Oxipng began as a complete rewrite of the OptiPNG project,