diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index f94959a..d96d4c1 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -14,9 +14,9 @@ This is a Bun workspaces monorepo. The widget package depends on sibling repos v ```bash # Clone all repos as siblings cd ~/Projects/deepgram # or your preferred directory -git clone git@github.com:deepgram/agent.git -git clone git@github.com:deepgram/react.git -git clone git@github.com:deepgram/ui.git +git clone https://github.com/deepgram/agent.git +git clone https://github.com/deepgram/react.git +git clone https://github.com/deepgram/ui.git # Build sibling dependencies cd react && bun install && bun run build && cd .. diff --git a/.github/workflows/cdn-dryrun.yml b/.github/workflows/cdn-dryrun.yml index 43726cd..1a970b1 100644 --- a/.github/workflows/cdn-dryrun.yml +++ b/.github/workflows/cdn-dryrun.yml @@ -15,6 +15,7 @@ permissions: jobs: dryrun-widget: + if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository runs-on: ubuntu-latest steps: - uses: actions/checkout@v6 diff --git a/README.md b/README.md index 993eb93..de565a5 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ Voice agent SDK and embeddable widget for the [Deepgram Agent API](https://devel @deepgram/agents ← @deepgram/react (external) ← @deepgram/ui (external) ← @deepgram/agents-widget ``` +## Status + +These packages are pre-1.0. Interfaces may change between minor versions, and releases are cut as the libraries evolve rather than on a fixed schedule. The packages in this family build on the [Deepgram Voice Agent API](https://developers.deepgram.com/docs/voice-agent) to provide browser SDKs, React hooks and UI components, and an embeddable widget. + ## Packages | Package | Description | @@ -42,9 +46,25 @@ The package also ships a UMD bundle at `dist/widget.umd.js` for `