docs: added description image shrink #522
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nd0ut
reviewed
Feb 20, 2024
| </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]. | ||
|
|
There was a problem hiding this comment.
Let's add a link to the API refs, like the other packages have.
nd0ut
reviewed
Feb 20, 2024
|
|
||
| ```typescript | ||
| import { shrinkFile } from '@uploadcare/image-shrink' | ||
| ``` |
There was a problem hiding this comment.
Maybe add some simple code example like const shrinkedBlob = shrinkImage(blob, {...})
nd0ut
reviewed
Feb 20, 2024
packages/image-shrink/README.md
Outdated
| 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]. |
There was a problem hiding this comment.
I think we need to notice here that this is browser-only implementation.
nd0ut
approved these changes
Feb 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Checklist