Skip to content

Commit

Permalink
Add instructions to boot the sample app (#45)
Browse files Browse the repository at this point in the history
  • Loading branch information
bcherry authored Aug 24, 2024
1 parent 83d160f commit 6de5fe8
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ npm add @livekit/track-processors

### Available processors

This package exposes `BackgroundBlur` and `VirtualBackground` as pre-prepared processor pipelines.
This package exposes the `BackgroundBlur` and `VirtualBackground` pre-prepared processor pipelines.

- `BackgroundBlur(blurRadius)`
- `VirtualBackground(imagePath)`
Expand Down Expand Up @@ -51,3 +51,13 @@ export const VirtualBackground = (imagePath: string) => {
### Available base transformers

- BackgroundTransformer (can blur background or use a virtual background);


## Running the sample app

This repository includes a small example app built on [Vite](https://vitejs.dev/). Run it with:

```
npm install
npm run sample
```

0 comments on commit 6de5fe8

Please sign in to comment.