Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chubkey3 committed Jul 19, 2023
1 parent 3420ae6 commit 51ae938
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Compress
A lightweight CLI tool for compressing image files and converting them to the webp format. Built on top of the imagemin library with added functionality such as preserving folder structure.

# Installation
## Installation

```npm install -g @chubkey/compress```

# Usage
## Usage

Once installed, the CLI tool can be used by typing ```compress``` into a terminal.

Expand All @@ -19,14 +19,14 @@ The library comes with a couple configuration flags used to direct the tool to y
| --webp | Converts files into webp format | false | --webp=true |
| --lossy | Specifies if compression should be lossy (true) or loseless (false) | true | --lossy=true |

# Examples
## Examples

```compress images compressed_images```

```compress --quality=85 --webp=true images compressed_images```

```compress --lossy=false images compressed_images```

# License
## License

This libary uses the [MIT License](https://github.com/chubkey3/react-image-uploader/blob/master/LICENSE).

0 comments on commit 51ae938

Please sign in to comment.