@mux/mux-uploader/README.md

An uploader elements to be used with Mux Direct Uploads

<p align="center">
  <h1 align="center">&lt;mux-uploader&gt;</h1>
  <a href="https://npmcharts.com/compare/@mux/mux-uploader?interval=30"><img src="https://img.shields.io/npm/dm/@mux/mux-uploader.svg?sanitize=true" alt="Downloads"></a>
    <a href="https://www.npmjs.com/package/@mux/mux-uploader"><img src="https://img.shields.io/npm/v/@mux/mux-uploader.svg?sanitize=true" alt="Version"></a>
    <a href="https://www.npmjs.com/package/@mux/mux-uploader"><img src="https://img.shields.io/npm/l/@mux/mux-uploader.svg?sanitize=true" alt="License"></a>
</p>

# Introduction

`<mux-uploader>` is the official Mux-flavored media uploader web component.

The uploading functionality is built using [`UpChunk`](https://github.com/muxinc/upchunk).

# Installation

```shell
npm install @mux/mux-uploader
```

or

```shell
yarn add @mux/mux-uploader
```

# Usage

```html
<mux-uploader
  endpoint="https://my-authenticated-url/storage?your-url-params"
></mux-uploader>
```

# Docs

Docs and guides live on [docs.mux.com](https://docs.mux.com/guides/video/mux-uploader?utm_source=github-mux-uploader).

API reference lives [on Github](./REFERENCE.md).