From 1a891072c09cf27928ad22c58e9b70cdd2555303 Mon Sep 17 00:00:00 2001 From: atjn Date: Thu, 20 May 2021 09:36:37 +0200 Subject: [PATCH] Fix broken links after libsquoosh release --- README.md | 2 +- cli/README.md | 2 +- libsquoosh/README.md | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 09698ca8..203703d3 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ by various image compressors. # API & CLI -Squoosh now has [an API](https://github.com/GoogleChromeLabs/squoosh/tree/dev/api) and [a CLI](https://github.com/GoogleChromeLabs/squoosh/tree/dev/cli) that allows you to compress many images at once. +Squoosh now has [an API](https://github.com/GoogleChromeLabs/squoosh/tree/dev/libsquoosh) and [a CLI](https://github.com/GoogleChromeLabs/squoosh/tree/dev/cli) that allows you to compress many images at once. # Privacy diff --git a/cli/README.md b/cli/README.md index b5519dbb..6286ba23 100644 --- a/cli/README.md +++ b/cli/README.md @@ -55,5 +55,5 @@ $ npx @squoosh/cli --wp2 auto test.png ``` [squoosh]: https://squoosh.app -[codecs.js]: https://github.com/GoogleChromeLabs/squoosh/blob/dev/cli/src/codecs.js +[codecs.js]: https://github.com/GoogleChromeLabs/squoosh/blob/dev/libsquoosh/src/codecs.js [butteraugli]: https://github.com/google/butteraugli diff --git a/libsquoosh/README.md b/libsquoosh/README.md index 222ba779..18fd9be2 100644 --- a/libsquoosh/README.md +++ b/libsquoosh/README.md @@ -30,7 +30,7 @@ const imagePath = 'path/to/image.png'; const image = imagePool.ingestImage(imagePath); ``` -These `ingestImage` function can take anything the node [`readFile`][readfile] function can take, uncluding a buffer and `FileHandle`. +The `ingestImage` function can take anything the node [`readFile`][readfile] function can take, uncluding a buffer and `FileHandle`. The returned `image` object is a representation of the original image, that you can now preprocess, encode, and extract information about. @@ -151,13 +151,13 @@ libSquoosh has an _experimental_ auto optimizer that compresses an image as much You can make use of the auto optimizer by using “auto” as the config object. -``` +```js const encodeOptions: { mozjpeg: 'auto', } ``` [squoosh]: https://squoosh.app -[codecs.js]: https://github.com/GoogleChromeLabs/squoosh/blob/dev/cli/src/codecs.js +[codecs.js]: https://github.com/GoogleChromeLabs/squoosh/blob/dev/libsquoosh/src/codecs.js [butteraugli]: https://github.com/google/butteraugli [readfile]: https://nodejs.org/api/fs.html#fs_fspromises_readfile_path_options