stoat-for-desktop/solid-livekit-components/README.md

30 lines
835 B
Markdown

<p>
<img width="100%" src="https://assets.solidjs.com/banner?type=solid-livekit-components&background=tiles&project=%20" alt="solid-livekit-components">
</p>
# solid-livekit-components
[![pnpm](https://img.shields.io/badge/maintained%20with-pnpm-cc00ff.svg?style=for-the-badge&logo=pnpm)](https://pnpm.io/)
Solid components for building applications with LiveKit
This is a port of [@livekit/components-react](https://www.npmjs.com/package/@livekit/components-react) to Solid.js, many features may be missing. The `hooks` part of the original library is analagous to `signals` in this project.
## Quick start
Install it:
```bash
npm i solid-livekit-components
# or
yarn add solid-livekit-components
# or
pnpm add solid-livekit-components
```
Use it:
```tsx
import solid-livekit-components from 'solid-livekit-components'
```