external-repos/squoosh
1
0
Fork 1
mirror of https://github.com/GoogleChromeLabs/squoosh.git synced 2025-11-12 08:47:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update libSquoosh README after rename

Browse Source
This commit is contained in:
Surma
2021-05-19 12:25:20 +01:00
parent c04bb54f0d
commit c36f4bebb8
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
libsquoosh/README.md
View File

@@ -1,21 +1,21 @@
# Squoosh API # libSquoosh
Squoosh API is an _experimental_ way to run all the codecs you know from the [Squoosh] web app directly inside your own JavaScript program. The Squoosh API uses a worker pool to parallelize processing images. This way you can apply the same codec to many images at once. libSquoosh is an _experimental_ way to run all the codecs you know from the [Squoosh] web app directly inside your own JavaScript program. libSquoosh uses a worker pool to parallelize processing images. This way you can apply the same codec to many images at once.
Squoosh API is currently not the fastest image compression tool in town and doesn’t aim to be. It is, however, fast enough to compress many images sufficiently quick at once. libSquoosh is currently not the fastest image compression tool in town and doesn’t aim to be. It is, however, fast enough to compress many images sufficiently quick at once.
## Installation ## Installation
The Squoosh API can be installed to your local project with the following command: libSquoosh can be installed to your local project with the following command:
``` ```
$ npm install @squoosh/api $ npm install @squoosh/lib
``` ```
You can start using the API by adding these lines to the top of your JS program: You can start using the libSquoosh by adding these lines to the top of your JS program:
```js ```js
import { ImagePool } from '@squoosh/api'; import { ImagePool } from '@squoosh/lib';
const imagePool = new ImagePool(); const imagePool = new ImagePool();
``` ```
@@ -147,7 +147,7 @@ console.log(await image.encodedWith.jxl);
## Auto optimizer ## Auto optimizer
Squoosh API has an _experimental_ auto optimizer that compresses an image as much as possible, trying to hit a specific [Butteraugli] target value. The higher the Butteraugli target value, the more artifacts can be introduced. libSquoosh has an _experimental_ auto optimizer that compresses an image as much as possible, trying to hit a specific [Butteraugli] target value. The higher the Butteraugli target value, the more artifacts can be introduced.
You can make use of the auto optimizer by using “auto” as the config object. You can make use of the auto optimizer by using “auto” as the config object.