Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
```
Expand Down
4 changes: 4 additions & 0 deletions packages/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down