Skip to content

Commit 4e56de5

Browse files
committed
Cleanup README
1 parent 9a16b3f commit 4e56de5

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

packages/image-convert/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,24 @@
11
# `@hkamran/image-convert`
2-
[![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL3.0-green.svg)](../../LICENSE.md) [![npm version](https://badge.fury.io/js/%40hkamran%2Fimage-convert.svg)](https://badge.fury.io/js/%40hkamran%2Fimage-convert.svg)
2+
3+
[![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL3.0-green.svg)](../../LICENSE.md)
4+
[![npm version](https://badge.fury.io/js/%40hkamran%2Fimage-convert.svg)](https://badge.fury.io/js/%40hkamran%2Fimage-convert.svg)
35

46
Convert images to the AVIF and WebP file formats
57

68
## Usage
9+
710
```bash
8-
$ npx @hkamran/image-convert
11+
npx @hkamran/image-convert
912
```
1013

1114
### Options
12-
- `--input` (default: `*.{jpg,jpeg,tif,tiff,png,gif,svg}`): Input filename(s), supports globs/wildcards
15+
16+
- `--input` (default: `*.{jpg,jpeg,tif,tiff,png,gif,svg}`): Input filename(s), supports
17+
globs/wildcards
1318
- `--output` (optional, defaults to current directory): Output directory
1419
- `--quality` (default: 50): Quality vs file size, 1 (lowest/smallest) to 100 (highest/largest)
1520
- `--speed` (default: 5): CPU effort vs file size, 0 (slowest/smallest) to 8 (fastest/largest)
1621
- `--lossless` (default: false): Use lossless compression
1722
- `--chromaSubsampling` (default: `4:4:4`): Set to `'4:2:0'` to use chroma subsampling
1823
- `--overwrite` (default: false): Allow existing files to be overwritten
19-
- `--verbose` (default: false): Write progress to stdout
24+
- `--verbose` (default: false): Write progress to stdout

0 commit comments

Comments
 (0)