Skip to content

docs: Quick Start is missing the adapter build step #8

@Lqm1

Description

@Lqm1

Quick Start is missing the adapter build step

Describe the issue

The Quick Start section shows how to install the adapter as a local file dependency:

bun add adapter-bun@file:../adapter-bun

However, it does not mention that adapter-bun must be built first (i.e. bun run build inside the adapter repo to generate dist/) before it can be used as a dependency. Without this step, the import will fail because the compiled output does not exist yet.

Suggested addition to Quick Start:

# 1. Build the adapter first
cd ../adapter-bun
bun install
bun run build

# 2. Then install as a local dependency in your Next.js project
cd ../your-next-app
bun add adapter-bun@file:../adapter-bun

Question

Is there a plan to publish this package to npm (or jsr)? That would eliminate the need for users to clone and build the adapter manually, and would make the Quick Start flow significantly simpler.

Happy to submit a PR to update the README if a docs fix is the preferred path. Thanks!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions