Skip to content

docs: make examples work #112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
auxesis merged 3 commits into from
Mar 14, 2025
Merged

docs: make examples work #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
96e67b5
fix(getting-started): ensure all schemas are imported
auxesis Mar 14, 2025
517dab2
docs(getting-started): make the options clearer and more obvious
auxesis Mar 14, 2025
c6ef5fa
docs(install): make bundling advice a section
auxesis Mar 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ To import the `protect` function and initialize a client with your defined schem

```ts
import { protect } from '@cipherstash/protect'
import { users } from './schema'
import { users, orders } from './schema'

// Pass all your tables to the protect function to initialize the client
export const protectClient = await protect(users, orders)
Expand Down
24 changes: 13 additions & 11 deletions packages/protect/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,20 +107,22 @@ Lastly, install the CipherStash CLI:
- [Linux ARM64](https://github.com/cipherstash/cli-releases/releases/latest/download/stash-aarch64-unknown-linux-gnu)
- [Linux x86_64](https://github.com/cipherstash/cli-releases/releases/latest/download/stash-x86_64-unknown-linux-gnu)

> [!NOTE]
> **You need to opt out of bundling when using Protect.js.**
>
> Protect.js uses Node.js specific features and requires the use of the [native Node.js `require`](https://nodejs.org/api/modules.html#requireid).
>
> 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).
>
> Read more about [building and bundling with Protect.js](#builds-and-bundling).
### Opt-out of bundling

> [!IMPORTANT]
> **You need to opt-out of bundling when using Protect.js.**

Protect.js uses Node.js specific features and requires the use of the [native Node.js `require`](https://nodejs.org/api/modules.html#requireid).

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).

Read more about [building and bundling with Protect.js](#builds-and-bundling).

## Getting started

If you're following this getting started guide with an existing app, skip to [the next step](#configuration).
🆕 **Existing app?** Skip to [the next step](#configuration).

If you're following this getting started guide with a clean slate, check out the dedicated [getting started guide](./docs/getting-started.md)
🌱 **Clean slate?** Check out the [getting started tutorial](./docs/getting-started.md).

### Configuration

Expand Down Expand Up @@ -207,7 +209,7 @@ To import the `protect` function and initialize a client with your defined schem

```ts
import { protect } from '@cipherstash/protect'
import { users } from './schema'
import { users, orders } from './schema'

// Pass all your tables to the protect function to initialize the client
export const protectClient = await protect(users, orders)
Expand Down