Skip to content

Commit d30da6e

Browse files
authored
Note that higher levels are not guaranteed to be better (#639)
Closes #638
1 parent e836688 commit d30da6e

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The most commonly used options are as follows:
5151

5252
- Optimization: `-o 0` through `-o 6` (or `-o max`), lower is faster, higher is better compression.
5353
The default (`-o 2`) is quite fast and provides good compression. Higher levels can be notably
54-
better but generally have increasingly diminishing returns.
54+
better* but generally have increasingly diminishing returns.
5555
- Strip: Used to remove metadata info from processed images. Used via `--strip [safe,all]`.
5656
Can save a few kilobytes if you don't need the metadata. "Safe" removes only metadata that
5757
will never affect rendering of the image. "All" removes all metadata that is not critical
@@ -66,7 +66,12 @@ More advanced options can be found by running `oxipng --help`, or viewed [here](
6666
Some options have both short (`-a`) and long (`--alpha`) forms. Which form you use is just a
6767
matter of preference. Multiple short options can be combined together, e.g.:
6868
`-savvo6` is equivalent to to `--strip safe --alpha --verbose --verbose --opt 6`.
69-
Note that all options are case-sensitive.
69+
All options are case-sensitive.
70+
71+
\* Note that oxipng is not a brute-force optimizer. This means that while higher optimization levels
72+
are almost always better or equal to lower levels, this is not guaranteed and it is possible in
73+
rare circumstances that a lower level may give a marginally smaller output. Similarly, using Zopfli
74+
compression (`-Z`) is not guaranteed to always be better than without.
7075

7176
## Git integration via [pre-commit]
7277

0 commit comments

Comments
 (0)