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

Add information about library usage to README [ci skip]

Browse source
This commit is contained in:
Joshua Holmer 2016-05-04 09:58:29 -04:00
parent a84611c9ae
commit 05f0e69e98
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -61,9 +61,21 @@ it if you have a good reason.
Can save a few kilobytes if you don't need the metadata. "Safe" removes only metadata that Can save a few kilobytes if you don't need the metadata. "Safe" removes only metadata that
will never affect rendering of the image. "All" removes all metadata that is not critical will never affect rendering of the image. "All" removes all metadata that is not critical
to the image. You can also pass a comma-separated list of specific metadata chunks to remove. to the image. You can also pass a comma-separated list of specific metadata chunks to remove.
`-s` can be used as a shorthand for `--strip safe`.
More advanced options can be found by running `oxipng -h`. More advanced options can be found by running `oxipng -h`.
## Library Usage
Although intended to be used as an executable, oxipng can also be used as a library in
other Rust projects. To do so, simply add oxipng as a dependency in your Cargo.toml,
then `extern crate oxipng` in your project. You should then have access to all of the library
functions [documented here](https://shssoichiro.github.io/oxipng/doc/oxipng/). The simplest
method of usage involves creating an
[Options struct](https://shssoichiro.github.io/oxipng/doc/oxipng/struct.Options.html) and
passing it, along with an input filename, into the
[optimize function](https://shssoichiro.github.io/oxipng/doc/oxipng/fn.optimize.html).
## History ## History
Oxipng began as a complete rewrite of the OptiPNG project, Oxipng began as a complete rewrite of the OptiPNG project,