Skip to content

Commit 71cd263

Browse files
committed
docs: add features and installation to README.md
1 parent eb04cab commit 71cd263

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,30 @@
11
# 🪝 vue-use-media-recorder
22

3+
A Vue Composable for the MediaRecorder API
4+
5+
## Features
6+
7+
- 🎥 Record audio and video streams
8+
- 📦 Auto import for Nuxt
9+
- 🎨 TypeScript support
10+
- 📚 [Documentation](https://orbisk.github.io/vue-use-media-recorder/)
11+
12+
## Installation
13+
14+
```bash
15+
pnpm add -D @orbisk/vue-use-media-recorder
16+
```
17+
18+
### Nuxt
19+
20+
Auto import for Nuxt is supported. Just add the module to your `nuxt.config`:
21+
22+
```ts
23+
export default defineNuxtConfig({
24+
modules: ['@orbisk/vue-use-media-recorder/nuxt']
25+
})
26+
```
27+
328
## Commands
429

530
Build the package:

0 commit comments

Comments
 (0)