Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanto committed Nov 17, 2020
1 parent deea912 commit 1772b1d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ The `useS3Upload` hook returns three items needed to coordinate the upload.

In order to take advantage of [next/image](https://nextjs.org/docs/api-reference/next/image) we'll need to know the image's height and width. For images uploaded by users it's best to capture these dimensions during the upload process.

This package ships with a helper that lets you get the height and width from image files. Here's an example of its usage.
This package ships with a `getImageData` helper that lets you get the height and width from image files. Here's an example of its usage.

```jsx
import { useState } from 'react';
Expand Down Expand Up @@ -208,7 +208,7 @@ export default function UploadTest() {
}
```

The `getImageData` is an async function that returns the height and width of the image. This data can be saved to your database alongside the URL of the image.
These height and width values can be saved to your database alongside the URL of the image.

## Help and questions

Expand Down

0 comments on commit 1772b1d

Please sign in to comment.