Skip to content

Commit 94f5410

Browse files
authored
Update README.md
1 parent c775923 commit 94f5410

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,6 @@ pnpm add @cipherstash/protect
7272
> [!TIP]
7373
> [Bun](https://bun.sh/) is not currently supported due to a lack of [Node-API compatibility](https://github.com/oven-sh/bun/issues/158). Under the hood, Protect.js uses [CipherStash Client](#cipherstash-client) which is written in Rust and embedded using [Neon](https://github.com/neon-bindings/neon).
7474
75-
> [!IMPORTANT]
76-
> If you're using Next.js, SST or a framework that generates client-side bundles, you may run into errors after installing protect.
77-
> See the configuration instructions for [Next.js](./docs/nextjs.md) or [SST](./docs/sst.md) for more information.
78-
79-
8075
Lastly, install the CipherStash CLI:
8176

8277
- On macOS:
@@ -88,7 +83,13 @@ Lastly, install the CipherStash CLI:
8883
- On Linux, download the binary for your platform, and put it on your `PATH`:
8984
- [Linux ARM64](https://github.com/cipherstash/cli-releases/releases/latest/download/stash-aarch64-unknown-linux-gnu)
9085
- [Linux x86_64](https://github.com/cipherstash/cli-releases/releases/latest/download/stash-x86_64-unknown-linux-gnu)
86+
87+
### Opt-out of bundling
88+
89+
Protect.js uses Node.js specific features and requires the use of the native Node.js `require`.
90+
You need to opt-out of bundling for tools like [Webpack](https://webpack.js.org/configuration/externals/), [esbuild](https://webpack.js.org/configuration/externals/), or [Next.js](https://nextjs.org/docs/app/api-reference/config/next-config-js/serverExternalPackages).
9191

92+
Read more about bundling [here](#builds-and-bundling).
9293

9394
## Getting started
9495

0 commit comments

Comments
 (0)