Skip to content
This repository has been archived by the owner on May 31, 2023. It is now read-only.

Commit

Permalink
docs: specify runtime support
Browse files Browse the repository at this point in the history
  • Loading branch information
joe-bell committed May 24, 2023
1 parent fc52db1 commit f515258
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
4 changes: 4 additions & 0 deletions docs/pages/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ import { Callout } from "nextra-theme-docs";

Plaiceholder is a server-side library. It will **not** work in the browser.

`plaiceholder` works on all runtimes supported by [`sharp`](https://sharp.pixelplumbing.com/).

[`sharp`](https://sharp.pixelplumbing.com/) is currently limited to Node.js, but there is a [pull request](https://github.com/lovell/sharp/pull/3522) to expand support.

</Callout>

## Prerequisites
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/docs/upgrading-to-3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ import { Callout } from "nextra-theme-docs";

`3.0` marks the end of the `plaiceholder` project, with this major release focussing on making the project feature complete and as future-proof as possible.

Once the `peerDependency` `sharp` [enables support for Non-Node.js projects](https://github.com/lovell/sharp/pull/3522), `plaiceholder` _should_ work seamlessly on all supported runtimes.
`plaiceholder` continues to work on all runtimes supported by [`sharp`](https://sharp.pixelplumbing.com/).
[`sharp`](https://sharp.pixelplumbing.com/) is currently limited to Node.js, but there is a [pull request](https://github.com/lovell/sharp/pull/3522) to expand support.

Preparing for wider support meant dropping some of the "magic" features that `plaiceholder` previously offered.
There is **no obligation** to upgrade to `3.0` if you would prefer to keep using the previous API!
Expand Down

3 comments on commit f515258

@vercel
Copy link

@vercel vercel bot commented on f515258 May 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vercel
Copy link

@vercel vercel bot commented on f515258 May 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vercel
Copy link

@vercel vercel bot commented on f515258 May 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.