captions.js/README.md

Render styled animated captions on canvas — works both on client and server side using Node.js and FFmpeg.

> [!WARNING]
> 🚧 **Captions.js is nearing its first public release**  
> The library is under active development and a full-featured version is expected around **November 2025**.

💌 Want to know when Captions.js is released?
Star or watch the repo on GitHub to get updates!

# Captions.js

A modern JavaScript library for adding captions to HTML5 videos with ease.

[**Live Demo**](https://maskin25.github.io/captions.js/)

[![Storybook](https://raw.githubusercontent.com/storybookjs/brand/refs/heads/main/badge/badge-storybook.svg)](https://main--68e681805917843931c33a87.chromatic.com/)

## Features

- **Easy Integration**: Simple API to add captions to your videos.
- **Customizable Styles**: Fully customizable caption styles via configurations.
- **Multiple Formats**: Supports various caption formats including WebVTT and SRT.
- **Responsive Design**: Captions adapt to different screen sizes and orientations.

## Installation

To install Captions.js, use npm or yarn:

```bash
npm install captions.js
```

or

```bash
yarn add captions.js
```

For development see [DEVELOPMENT.md](./DEVELOPMENT.md).