Skip to content

Commit

Permalink
docs(readme): add badges & updates (#160)
Browse files Browse the repository at this point in the history
* docs: add badges, readme tweaks

* docs: add auto-generated captions bullet
  • Loading branch information
luwes authored Feb 5, 2024
1 parent e93698f commit 5bcb9fd
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
# `next-video`

[![npm version](https://img.shields.io/npm/v/next-video?style=flat-square&color=success)](http://npmjs.org/next-video)
[![size](https://img.shields.io/bundlephobia/minzip/next-video?label=size&style=flat-square)](https://bundlephobia.com/result?p=next-video)

Next video is a react component for adding video to your [next.js](https://github.com/vercel/next.js) application. It extends both the `<video>` element and your Next app with features for automatic video optimization.

- **Smart storage:** Store large video files outside of your git repo
- **Auto optimized**: Automatically optimize video files and deliver via CDN for better playback performance and quality
- **Auto optimized**: Optimize video files and deliver via CDN for better playback performance and quality
- **Customizable UI:** Choose from themes or build your own player controls
- **Posters & Previews:** Zero-config placeholder images and timeline hover thumbnails
- **Wider compatibility:** Use videos that aren’t supported natively by all browsers
- **Analytics built-in (optional):** See how often videos get watched and track video performance
- **AI-powered:** Whisper captions coming soon...
- **AI-powered:** Add [auto-generated captions](https://docs.mux.com/guides/add-autogenerated-captions-and-use-transcripts?utm_source=next-video.dev) to your videos and use transcripts


```tsx
import Video from 'next-video';
Expand Down Expand Up @@ -305,9 +309,9 @@ If you're using Amazon S3 as the provider, you'll need to create a new IAM user

### v1

- [ ] Customizable player
- [x] Customizable player
- [x] Connectors for additional video services
- [ ] AI captions
- [x] AI captions

## Trying it out locally

Expand Down

0 comments on commit 5bcb9fd

Please sign in to comment.