Skip to content

Commit c6ef5fa

Browse files
committed
docs(install): make bundling advice a section
Feedback from users is it's little easier to read when skimming for the first time
1 parent 517dab2 commit c6ef5fa

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

packages/protect/README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -107,14 +107,16 @@ Lastly, install the CipherStash CLI:
107107
- [Linux ARM64](https://github.com/cipherstash/cli-releases/releases/latest/download/stash-aarch64-unknown-linux-gnu)
108108
- [Linux x86_64](https://github.com/cipherstash/cli-releases/releases/latest/download/stash-x86_64-unknown-linux-gnu)
109109

110-
> [!NOTE]
111-
> **You need to opt out of bundling when using Protect.js.**
112-
>
113-
> Protect.js uses Node.js specific features and requires the use of the [native Node.js `require`](https://nodejs.org/api/modules.html#requireid).
114-
>
115-
> 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).
116-
>
117-
> Read more about [building and bundling with Protect.js](#builds-and-bundling).
110+
### Opt-out of bundling
111+
112+
> [!IMPORTANT]
113+
> **You need to opt-out of bundling when using Protect.js.**
114+
115+
Protect.js uses Node.js specific features and requires the use of the [native Node.js `require`](https://nodejs.org/api/modules.html#requireid).
116+
117+
When using Protect.js, 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).
118+
119+
Read more about [building and bundling with Protect.js](#builds-and-bundling).
118120

119121
## Getting started
120122

0 commit comments

Comments
 (0)