Skip to content

docs: make npm package links more prominent #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexanderqchen merged 1 commit into from
Sep 17, 2026
Merged

docs: make npm package links more prominent #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# orb-ui

[![npm version](https://img.shields.io/npm/v/orb-ui.svg)](https://www.npmjs.com/package/orb-ui)

**Voice agent UI that feels alive.**

Expressive, accessible React components for realtime voice agents. Connect Vapi, ElevenLabs, LiveKit, Pipecat, OpenAI Realtime, Gemini Live, or your own voice stack through one consistent UI layer.
Expand Down Expand Up @@ -32,7 +34,7 @@ speaking motion. The adapter keeps microphone and output calibration separate.

## Install

Install the component package:
Install the [orb-ui package from npm](https://www.npmjs.com/package/orb-ui):

```bash
npm install orb-ui
Expand Down
27 changes: 26 additions & 1 deletion demo/src/App.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import { highlightTsx } from './syntax-highlight'
const STATES: OrbState[] = ['idle', 'connecting', 'listening', 'thinking', 'speaking', 'error']
const THEMES: OrbThemeName[] = ['circle', 'bars', 'cloud', 'radial', 'debug']
const GITHUB_REPO_URL = 'https://github.com/alexanderqchen/orb-ui'
const NPM_PACKAGE_URL = 'https://www.npmjs.com/package/orb-ui'
const GITHUB_STAR_COLOR = '#8bc7ff'

type DemoMode = 'simulation' | 'manual'
Expand Down Expand Up @@ -628,6 +629,21 @@ export default function App() {
margin-top: 34px;
}

.hero-copy__package-link {
color: #858585;
display: inline-flex;
font-size: 13px;
gap: 6px;
margin-top: 14px;
text-decoration: none;
transition: color 160ms ease;
}

.hero-copy__package-link:hover,
.hero-copy__package-link:focus-visible {
color: #fff;
}

.install-command {
align-items: center;
background: rgba(16, 16, 16, 0.9);
Expand Down Expand Up @@ -1757,6 +1773,15 @@ export default function App() {
</a>
</div>

<a
href={NPM_PACKAGE_URL}
target="_blank"
rel="noreferrer"
className="hero-copy__package-link"
>
View package on npm <span aria-hidden="true">↗</span>
</a>

<div className="hero-providers" aria-label="Supported provider guides">
<span>Native paths</span>
{PROVIDER_GUIDES.slice(0, 6).map((provider) => (
Expand Down Expand Up @@ -2058,7 +2083,7 @@ export default function App() {
<h2>Product</h2>
<a href="/docs">Documentation</a>
<a href="/playground">Playground</a>
<a href="https://www.npmjs.com/package/orb-ui" target="_blank" rel="noreferrer">
<a href={NPM_PACKAGE_URL} target="_blank" rel="noreferrer">
npm package
</a>
</div>
Expand Down