diff --git a/README.md b/README.md index a19e0ea..ba70238 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 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 ```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..356c9ee 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 pre-1.0. Interfaces may change between minor versions. + ## Install ```bash