Skip to content

docs(journeys): link npm package and drop SDK beta notice #133

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
DeolaJ merged 2 commits into from
Jun 17, 2026
Merged

docs(journeys): link npm package and drop SDK beta notice #133

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
efdbfb7
docs(journeys): link npm package and drop SDK beta notice
Jun 17, 2026
8e749f8
chore: typo update
Jun 17, 2026
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
6 changes: 3 additions & 3 deletions docs/journeys/sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ The Journey Embed SDK is a chainable JavaScript API for rendering epilot Journey
- A **rewritten iframe engine** that replaces the legacy [`__epilot` script](/docs/journeys/embedding) with a faster, cleaner host integration.
- The [`<epilot-journey>` Web Component](/docs/journeys/web-components), a custom HTML element that renders in Shadow DOM.

:::info Beta
:::info Backward compatibility

The SDK is in beta. Test it before rolling out to production. Existing embeds using the [legacy `__epilot` script](/docs/journeys/embedding) continue to work.
Existing embeds using the [legacy `__epilot` script](/docs/journeys/embedding) continue to work, but this SDK is preferred going forward

:::

Expand Down Expand Up @@ -87,7 +87,7 @@ Before the bundle loads, `onReady(cb)` pushes `cb` onto a queue. When the bundle

### Option 3: npm package

For bundler-based apps (Next.js, Vite, Webpack, etc.), install the SDK from npm. You'll get full TypeScript types and autocomplete:
For bundler-based apps (Next.js, Vite, Webpack, etc.), install [`@epilot/journey-embed-sdk`](https://www.npmjs.com/package/@epilot/journey-embed-sdk) from npm. You'll get full TypeScript types and autocomplete:

```bash
npm install @epilot/journey-embed-sdk
Expand Down
Loading