readme

Author: Gleb Mikheev

README.md

@@ -1,6 +1,6 @@
 # image-optimize-loader
 
-Optimize images with global caching and png to jpg conversion (on the go)
+Optimize images with global caching and non-transparent png to jpg conversion (on the go)
 > Rework of https://github.com/tcoopman/image-webpack-loader
 
 ## Install
@@ -25,141 +25,32 @@ loaders: [
 ## Configuration
 
 ```
-{
+{ // default configuration example
   imageOptimizeLoader: {
-    pngquant:{
-      quality: "65-90",
+    optimizer: {
+      covertPngToJpg:true
+    },
+    pngquant: {
+      quality: '65-80',
       speed: 4
     },
-    svgo:{
-      plugins: [
-        {
-          removeViewBox: false
-        },
-        {
-          removeEmptyAttrs: false
-        }
+    mozjpeg:{
+      targa: false,
+    },
+    svgo: {
+      plugins:[
+        { removeComments: true },
+        { sortAttrs: true },
+        { minifyStyles: true },
       ]
     }
-  }
 }
 ```
 
 Comes bundled with the following optimizers:
-- [gifsicle](https://github.com/kevva/imagemin-gifsicle) — *Compress GIF image*
-- [jpegtran](https://github.com/kevva/imagemin-jpegtran) — *Compress JPEG images*
-- [optipng](https://github.com/kevva/imagemin-optipng) — *Compress PNG images*
+- [mozjpeg](https://github.com/imagemin/imagemin-mozjpeg) — *Compress JPEG images*
 - [svgo](https://github.com/kevva/imagemin-svgo) — *Compress SVG images*
-- [pngquant](https://pngquant.org/) — *Compress PNG images*
-
-### imagemin(options)
-
-Unsupported files are ignored.
-
-### options
-
-Options are applied to the correct files.
-
-#### optimizationLevel *(png)*
-
-Type: `number`  
-Default: `3`
-
-Select an optimization level between `0` and `7`.
-
-> The optimization level 0 enables a set of optimization operations that require minimal effort. There will be no changes to image attributes like bit depth or color type, and no recompression of existing IDAT datastreams. The optimization level 1 enables a single IDAT compression trial. The trial chosen is what. OptiPNG thinks it’s probably the most effective. The optimization levels 2 and higher enable multiple IDAT compression trials; the higher the level, the more trials.
-
-Level and trials:
-
-1. 1 trial
-2. 8 trials
-3. 16 trials
-4. 24 trials
-5. 48 trials
-6. 120 trials
-7. 240 trials
-
-#### progressive *(jpg)*
-
-Type: `boolean`  
-Default: `false`
-
-Lossless conversion to progressive.
-
-#### interlaced *(gif)*
-
-Type: `boolean`  
-Default: `false`
-
-Interlace gif for progressive rendering.
-
-#### svgo *(svg)*
-
-Type: `object`
-Default: `{}`
-
-Pass options to [svgo](https://github.com/svg/svgo).
-
-#### bypassOnDebug *(all)*
-
-Type: `boolean`  
-Default: `false`
-
-Using this, no processing is done when webpack 'debug' mode is used and the loader acts as a regular file-loader. Use this to speed up initial and, to a lesser extent, subsequent compilations while developing or using webpack-dev-server. Normal builds are processed normally, outputting oprimized files.
-
-### imageminPngquant(options)
-
-#### options.floyd
-
-Type: `number`  
-Default: `0.5`
-
-Controls level of dithering (0 = none, 1 = full).
-
-#### options.nofs
-
-Type: `boolean`  
-Default: `false`
-
-Disable Floyd-Steinberg dithering.
-
-#### options.posterize
-
-Type: `number`
-
-Reduce precision of the palette by number of bits. Use when the image will be
-displayed on low-depth screens (e.g. 16-bit displays or compressed textures).
-
-#### options.quality
-
-Type: `string`
-
-Instructs pngquant to use the least amount of colors required to meet or exceed
-the max quality. If conversion results in quality below the min quality the
-image won't be saved.
-
-Min and max are numbers in range 0 (worst) to 100 (perfect), similar to JPEG.
-
-#### options.speed
-
-Type: `number`  
-Default: `3`
-
-Speed/quality trade-off from `1` (brute-force) to `10` (fastest). Speed `10` has
-5% lower quality, but is 8 times faster than the default.
-
-#### options.verbose
-
-Type: `boolean`  
-Default: `false`
-
-Print verbose status messages.
-
-## Inspiration
-
-* [gulp-imagemin](https://github.com/sindresorhus/gulp-imagemin)
-* [file-loader](https://github.com/webpack/file-loader)
-* [imagemin-pngquant](https://github.com/imagemin/imagemin-pngquant)
+- [pngquant](https://github.com/imagemin/imagemin-pngquant) — *Compress PNG images*
 
 ## License