From 05f0e69e9827c5b57a9218b07c0b070e652ba865 Mon Sep 17 00:00:00 2001 From: Joshua Holmer Date: Wed, 4 May 2016 09:58:29 -0400 Subject: [PATCH] Add information about library usage to README [ci skip] --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index e61e0210..a4840a78 100644 --- a/README.md +++ b/README.md @@ -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 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. +`-s` can be used as a shorthand for `--strip safe`. 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 Oxipng began as a complete rewrite of the OptiPNG project,