Add minify-image module (#1149)

* Add minify-image module * Add node modules * corrected path * Add browser func * Add test and documentation
publiclab · Jul 9, 2019 · 1b26f71 · 1b26f71
1 parent 8033af9
commit 1b26f71
Show file tree

Hide file tree

Showing 8 changed files with 1,629 additions and 146 deletions.
diff --git a/docs/MODULES.md b/docs/MODULES.md
@@ -39,6 +39,7 @@ List of Module Documentations
 34. [Tint](#tint)
 35. [ColorTemperature](#color-temperature)
 36. [Grid-Overlay](#grid-overlay)
+37. [MinifyImage](#minify-image)
 
 
 ## crop-module
@@ -600,4 +601,18 @@ This adds the grid over an image.
 where `options` is an object with the following property:
 * options.x : The value at which the grid line should start in x-axis.
 * options.y : The value at which the grid line should start in y-axis.
-* color : Color for the grid on the image.
+* color : Color for the grid on the image.
+
+# Minify Image
+
+This module minifies the image using lossy compression that is the image-dimensions are not lost but the size is reduced.
+
+The module supports jpg/jpeg/webp images in browser; but the node version supports all of the types.
+
+## Usage
+
+```js
+sequencer.loadImage('PATH')
+           .addSteps('minify-image')
+           .run()
+```