Skip to content

Commit

Permalink
docs: add features and installation to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
OrbisK committed Nov 26, 2024
1 parent eb04cab commit 71cd263
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,30 @@
# 🪝 vue-use-media-recorder

A Vue Composable for the MediaRecorder API

## Features

- 🎥 Record audio and video streams
- 📦 Auto import for Nuxt
- 🎨 TypeScript support
- 📚 [Documentation](https://orbisk.github.io/vue-use-media-recorder/)

## Installation

```bash
pnpm add -D @orbisk/vue-use-media-recorder
```

### Nuxt

Auto import for Nuxt is supported. Just add the module to your `nuxt.config`:

```ts
export default defineNuxtConfig({
modules: ['@orbisk/vue-use-media-recorder/nuxt']
})
```

## Commands

Build the package:
Expand Down

0 comments on commit 71cd263

Please sign in to comment.