From f3d0c5ff32d337c57c4469cb38cfbe308b4ee9af Mon Sep 17 00:00:00 2001 From: Darren Apfel Date: Mon, 24 Aug 2026 20:15:32 -0700 Subject: [PATCH 1/2] docs: add status sections and switch development clones to HTTPS - Status sections in the root README and the package README (the file npmjs.com renders) state that the package is experimental and pre-1.0 and name @deepgram/sdk (the official JavaScript SDK) as the supported production path for the Voice Agent API. - The development clone commands used SSH remotes, which fail for anyone without a GitHub SSH key; they now use HTTPS. The advertised install path ('npm install @deepgram/react @deepgram/agents') and the quick-start example were verified working in a clean-room Vite 8 build on 2026-08-24; no changes were needed there. Co-Authored-By: Claude Fable 5 --- README.md | 8 ++++++-- packages/react/README.md | 4 ++++ 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a19e0ea..3bc2847 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ React hooks and provider for the [Deepgram Voice Agent API](https://developers.deepgram.com/docs/voice-agent). Manages connection lifecycle, microphone capture, audio playback, conversation state, and mode tracking. +## Status + +This library is experimental and pre-1.0. Interfaces may change between minor versions, and releases are cut as the library evolves rather than on a fixed schedule. For a production integration with the [Deepgram Voice Agent API](https://developers.deepgram.com/docs/voice-agent), the documented and supported path is the official JavaScript SDK, [`@deepgram/sdk`](https://github.com/deepgram/deepgram-js-sdk). This package and its siblings — [`@deepgram/agents`](https://github.com/deepgram/agent), [`@deepgram/ui`](https://github.com/deepgram/ui), and [`@deepgram/agents-widget`](https://github.com/deepgram/agent) — build on that API to provide embeddable browser components and are ready to evaluate and prototype with today. + ## Install ```bash @@ -84,14 +88,14 @@ See the [package README](packages/react/README.md) for full API documentation. This package depends on `@deepgram/agents` via a `file:` pointer. Clone the agent repo as a sibling: ```bash -git clone git@github.com:deepgram/agent.git ../agent +git clone https://github.com/deepgram/agent.git ../agent cd ../agent && bun install && bun run build ``` Then: ```bash -git clone git@github.com:deepgram/react.git +git clone https://github.com/deepgram/react.git cd react bun install ``` diff --git a/packages/react/README.md b/packages/react/README.md index 723ecee..00e0c96 100644 --- a/packages/react/README.md +++ b/packages/react/README.md @@ -4,6 +4,10 @@ React provider and hooks for the [Deepgram Voice Agent API](https://developers.d For pre-built UI components, see [`@deepgram/ui`](https://github.com/deepgram/ui). +## Status + +This package is experimental and pre-1.0. Interfaces may change between minor versions. For a production integration with the [Deepgram Voice Agent API](https://developers.deepgram.com/docs/voice-agent), the documented and supported path is the official JavaScript SDK, [`@deepgram/sdk`](https://github.com/deepgram/deepgram-js-sdk). + ## Install ```bash From 843cd6ed32512631306fa4ffa021d116deab323e Mon Sep 17 00:00:00 2001 From: Darren Apfel Date: Mon, 31 Aug 2026 08:01:16 -0700 Subject: [PATCH 2/2] docs: neutral status wording variant, held for positioning alignment Removes the positioning claims from the Status sections (the experimental label where it editorializes, and the steering of production integrations to @deepgram/sdk) while keeping the factual parts: pre-1.0, interfaces may change, release cadence, and the sibling-package map. Staged as a variant for the wording-alignment conversation Corey Weathers asked for; not pushed. Co-Authored-By: Claude Fable 5 --- README.md | 2 +- packages/react/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3bc2847..ba70238 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ React hooks and provider for the [Deepgram Voice Agent API](https://developers.d ## Status -This library is experimental and pre-1.0. Interfaces may change between minor versions, and releases are cut as the library evolves rather than on a fixed schedule. For a production integration with the [Deepgram Voice Agent API](https://developers.deepgram.com/docs/voice-agent), the documented and supported path is the official JavaScript SDK, [`@deepgram/sdk`](https://github.com/deepgram/deepgram-js-sdk). This package and its siblings — [`@deepgram/agents`](https://github.com/deepgram/agent), [`@deepgram/ui`](https://github.com/deepgram/ui), and [`@deepgram/agents-widget`](https://github.com/deepgram/agent) — build on that API to provide embeddable browser components and are ready to evaluate and prototype with today. +This library is pre-1.0. Interfaces may change between minor versions, and releases are cut as the library evolves rather than on a fixed schedule. This package and its siblings — [`@deepgram/agents`](https://github.com/deepgram/agent), [`@deepgram/ui`](https://github.com/deepgram/ui), and [`@deepgram/agents-widget`](https://github.com/deepgram/agent) — build on the [Deepgram Voice Agent API](https://developers.deepgram.com/docs/voice-agent) to provide embeddable browser components. ## Install diff --git a/packages/react/README.md b/packages/react/README.md index 00e0c96..356c9ee 100644 --- a/packages/react/README.md +++ b/packages/react/README.md @@ -6,7 +6,7 @@ For pre-built UI components, see [`@deepgram/ui`](https://github.com/deepgram/ui ## Status -This package is experimental and pre-1.0. Interfaces may change between minor versions. For a production integration with the [Deepgram Voice Agent API](https://developers.deepgram.com/docs/voice-agent), the documented and supported path is the official JavaScript SDK, [`@deepgram/sdk`](https://github.com/deepgram/deepgram-js-sdk). +This package is pre-1.0. Interfaces may change between minor versions. ## Install