Update README

This commit is contained in:
Ralph Slooten 2019-08-24 23:26:24 +12:00
parent 0c000fe262
commit b157fcd72b

View File

@ -1,8 +1,8 @@
# Goptimizer - downscales and optimizes images # Goptimizer - downscales and optimizes images
Goptimizer is a commandline utility written in Golang. It downscales and optimize existing images JPEG, PNG and Gif files. Goptimizer is a commandline utility written in Golang. It downscales and optimizes JPEG, PNG and Gif files.
Image downscaling is done within Goptimize (`-m <width>x<height>`, see [Usage](#usage-options)), however optimization is done using the following additional tools (if they are installed): Image downscaling/rotation is done within goptimize (`-m <width>x<height>`, see [Usage](#usage-options)), however optimization is done using the following additional tools (if they are installed):
- jpegoptim - jpegoptim
- jpegtran (`libjpeg-turbo-progs`) - jpegtran (`libjpeg-turbo-progs`)
@ -28,25 +28,18 @@ It will also preserve (by default) the file's original modification times (`-p=f
Usage: ./goptimize [options] <images> Usage: ./goptimize [options] <images>
Options: Options:
-gifsicle string -q, --quality int quality, JPEG only (default 75)
gifsicle binary (default "gifsicle") -m, --max string downscale to a maximum width & height in pixels (<width>x<height>)
-jpegoptim string -o, --out string output directory (default overwrites original)
jpegoptim binary (default "jpegoptim") -p, --preserve preserve file modification times (default true)
-jpegtran string -u, --update update to latest release
jpegtran binary (default "jpegtran") -v, --version show version number
-m string -h, --help show help
downscale to a maximum width & height in pixels (<width>x<height>) --jpegtran string jpegtran binary (default "jpegtran")
-o string --jpegoptim string jpegoptim binary (default "jpegoptim")
output directory (default overwrites original) --gifsicle string gifsicle binary (default "gifsicle")
-optipng string --pngquant string pngquant binary (default "pngquant")
optipng binary (default "optipng") --optipng string optipng binary (default "optipng")
-p preserve file modification times (default true)
-pngquant string
pngquant binary (default "pngquant")
-q int
quality - JPEG only (default 75)
-u update to latest release
-v show version number
``` ```