diff --git a/libsquoosh/README.md b/libsquoosh/README.md index 3c11e010..af8c9a93 100644 --- a/libsquoosh/README.md +++ b/libsquoosh/README.md @@ -42,11 +42,19 @@ When an image has been ingested, you can start preprocessing it and encoding it await image.decoded; //Wait until the image is decoded before running preprocessors. const preprocessOptions = { + //When both width and height are specified, the image resized to specified size. resize: { enabled: true, width: 100, height: 50, } + /* + //When either width or height is specified, the image resized to specified size keeping aspect ratio. + resize: { + enabled: true, + width: 100, + } + */ } await image.preprocess(preprocessOptions);