Skip to content

Commit

Permalink
chore: add requirements to README
Browse files Browse the repository at this point in the history
Per the conversation in
#409, I'm
adding a "Requirements to know about" list in a prominent place so that
folx can know early when evaluating the package.
  • Loading branch information
rpearce committed Apr 17, 2023
1 parent e5d941e commit 200d644
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
The original [medium.com-inspired image zooming](https://medium.design/image-zoom-on-medium-24d146fc0c20)
library for [React](https://reactjs.org).

[View the storybook examples](https://rpearce.github.io/react-medium-image-zoom/)
to see various usages.

Features:

* `<img />`, including all [`object-fit`](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit)
Expand All @@ -27,10 +30,12 @@ Features:
* [Next.js](https://nextjs.org/docs/api-reference/next/image)
* Zero `dependencies`

[View the storybook examples](https://rpearce.github.io/react-medium-image-zoom/)
to see various usages. _NOTE: Help is wanted with making the examples more
informative, so please [start a discussion](https://github.com/rpearce/react-medium-image-zoom/discussions)
if you're able to help!_
Requirements to know about:

* `<dialog>` element ([caniuse dialog](https://caniuse.com/dialog))
* `ResizeObserver` ([caniuse ResizeObserver](https://caniuse.com/mdn-api_resizeobserver))
* Package build target is `ES2021`. If you need to support older environments,
run this package through your build system.

## Quickstart

Expand All @@ -54,9 +59,6 @@ export const MyImg = () => (
)
```

This library's compilation target is `ES2021`. If you find you need to support
older environments, run this project through your build system.

## API

You can pass these options to either the `Uncontrolled` (default) or
Expand Down

0 comments on commit 200d644

Please sign in to comment.