Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vHeemstra committed Nov 20, 2023
1 parent 4782821 commit 08ab50b
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
- Can create Avif versions of supported images (jpg/png).
- Skips optimized version if output is larger than original.
- Skips Avif/WebP version if output is larger than original, optimized version or smallest version of an image.
- Uses cache to skip processing of unchanged files
- Uses optional cache by default to skip processing of unchanged files

## Install

Expand Down Expand Up @@ -116,6 +116,30 @@ Default: `true`

> Skip optimizing the input if it did not change since the last run.
### cacheDir

Type: `string`<br>
Default: `<packageRoot>/node_modules/.cache/vite-plugin-imagemin/<packageName>/`

> Choose the directory to use for caching.
> - Relative paths will be relative to the Vite project's **root** directory.
> - Absolute paths will be use as-is.
> - Absent/non-string value will use the default location.
### clearCache

Type: `boolean`<br>
Default: `false`

> Clears the cache folder before processing.
### cache

Type: `boolean`<br>
Default: `true`

> Skip optimizing the input if it did not change since the last run.
### makeAvif / makeWebp

Type: `object`<br>
Expand Down

0 comments on commit 08ab50b

Please sign in to comment.