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

Update readme [ci skip]

Browse source
This commit is contained in:
Josh Holmer 2016-07-14 21:58:54 -04:00
parent 0cb052fbff
commit 04f8e23e0f
1 changed files with 8 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -6,14 +6,8 @@
## Overview ## Overview
Oxipng is a lossless PNG compression optimizer. Oxipng is a multithreaded lossless PNG compression optimizer. It can be used via a command-line
interface or as a library in other Rust programs.
**Note:** This package should be considered a beta. Although there are many tests in place,
there is still a chance of data loss or corruption. You should backup your files before
using this tool, unless you are very brave.
If you encounter an issue, please report it via the GitHub issues tab. Include as many details
as possible.
## Installing ## Installing
@ -56,7 +50,7 @@ to give any extra compression gains and is not recommended.
PNG interlacing on any images that are processed. `-i 0` will remove interlacing from all PNG interlacing on any images that are processed. `-i 0` will remove interlacing from all
processed images. Not specifying either will keep the same interlacing state as the processed images. Not specifying either will keep the same interlacing state as the
input image. Note: Interlacing can add 25-50% to the size of an optimized image. Only use input image. Note: Interlacing can add 25-50% to the size of an optimized image. Only use
it if you have a good reason. it if you believe the benefits outweight the costs for your use case.
* Strip: Used to remove metadata info from processed images. Used via `--strip [safe,all]`. * Strip: Used to remove metadata info from processed images. Used via `--strip [safe,all]`.
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
@ -67,7 +61,7 @@ More advanced options can be found by running `oxipng -h`.
## Library Usage ## Library Usage
Although intended to be used as an executable, oxipng can also be used as a library in Although originally 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, 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 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 functions [documented here](https://shssoichiro.github.io/oxipng/doc/oxipng/). The simplest
@ -89,10 +83,10 @@ This also served as an opportunity to choose a more modern, safer language (Rust
## Contributing ## Contributing
Any contributions are welcome and will be accepted via pull request on GitHub. Bug reports can be Any contributions are welcome and will be accepted via pull request on GitHub. Bug reports can be
filed via GitHub issues. If you have the capability to submit a fix with the bug report, it is filed via GitHub issues. Please include as many details as possible. If you have the capability
preferred that you do so via pull request, however you do not need to be a Rust programmer to to submit a fix with the bug report, it is preferred that you do so via pull request,
contribute. Other contributions (such as improving documentation or translations) are also however you do not need to be a Rust developer to contribute.
welcome via GitHub. Other contributions (such as improving documentation or translations) are also welcome via GitHub.
## License ## License