merge-vtt/Readme.md

A simple tool to merge multiple WebVTT (.vtt) files into a single file.

# merge-vtt

A simple Node.js module to merge multiple WebVTT (.vtt) files into a single file. This can be particularly useful when you have separate subtitle files for different segments of a video and need to combine them for continuous playback.

## Installation

Install the package via npm:

    npm install merge-vtt

Or via yarn:

    yarn add merge-vtt

## Usage

To use `merge-vtt` in your project, you can require the module and then call the `mergeVTT` function with an array of VTT content strings.

    const  {  mergeVTT  }  =  require("merge-vtt");

    // Example transcriptions

    const  transcription1  =  `WEBVTT\n\n1\n00:00:00.000 --> 00:00:04.000\nFirst subtitle\n\n`;

    const  transcription2  =  `WEBVTT\n\n1\n00:00:02.000 --> 00:00:06.000\nSecond subtitle\n\n`;


    const  mergedVTTContent  =  mergeVTT([transcription1,  transcription2]);

    console.log(mergedVTTContent);

The above will output the merged VTT content to the console.

## API

### `mergeVTT(transcriptions)`

Merges an array of VTT content strings into a single VTT content string.

#### Parameters

- `transcriptions` - An array of VTT file content strings to be merged.

#### Returns

- Returns a string with merged VTT content.

## Example

Given two VTT files:

`file1.vtt`
WEBVTT
1
00:00:00.000 --> 00:00:04.000
First subtitle

`file2.vtt`
WEBVTT
1
00:00:02.000 --> 00:00:06.000
Second subtitle

Merging these using `mergeVTT` would produce:

    WEBVTT
    1
    00:00:00.000 --> 00:00:04.000
    First subtitle
    2
    00:00:06.000 --> 00:00:10.000
    Second subtitle

## Contributing

Contributions are welcome! Please feel free to submit a pull request or create an issue if you find a bug or have a feature request.

## License

This project is licensed under the ISC License - see the LICENSE.md file for details.