Skip to content

Commit

Permalink
docs: update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
egordidenko committed Feb 20, 2024
1 parent fd124a4 commit 937a5f9
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion packages/image-shrink/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
alt="">
</a>

File Uploader lets you accept hi-res images and shrink them in size to a reasonable resolution, keeping the original aspect ratio. See docs [here][uc-docs-image-shrink].
File Uploader lets you accept hi-res images and shrink them in size to a reasonable resolution, keeping the original aspect ratio. See docs [here][uc-docs-image-shrink] wrapper to work with browser.

[API Reference](https://uploadcare.github.io/uploadcare-js-api-clients/image-shrink/)

[![Build Status][badge-build]][build-url]
[![NPM version][npm-img]][npm-url]
Expand All @@ -32,6 +34,11 @@ npm install @uploadcare/image-shrink

```typescript
import { shrinkFile } from '@uploadcare/image-shrink'

const shrinkedBlob = shrinkImage(blob, {
size: number,
quality?: number
})
```

## Security issues
Expand Down

0 comments on commit 937a5f9

Please sign in to comment.