captions.js 0.3.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +35 -0
  2. package/package.json +18 -1
package/README.md ADDED
@@ -0,0 +1,35 @@
1
+ > [!WARNING]
2
+ > This project is a work in progress.
3
+
4
+ # Captions.js
5
+
6
+ A modern JavaScript library for adding captions to HTML5 videos with ease.
7
+
8
+ ## Features
9
+
10
+ - **Easy Integration**: Simple API to add captions to your videos.
11
+ - **Customizable Styles**: Fully customizable caption styles via configurations.
12
+ - **Multiple Formats**: Supports various caption formats including WebVTT and SRT.
13
+ - **Responsive Design**: Captions adapt to different screen sizes and orientations.
14
+
15
+ ## Installation
16
+
17
+ To install Captions.js, use npm or yarn:
18
+
19
+ ```bash
20
+ npm install captions.js
21
+ ```
22
+
23
+ or
24
+
25
+ ```bash
26
+ yarn add captions.js
27
+ ```
28
+
29
+ For development see [DEVELOPMENT.md](./DEVELOPMENT.md).
30
+
31
+ ```bash
32
+ yarn add captions.js
33
+ ```
34
+
35
+ For development see [DEVELOPMENT.md](./DEVELOPMENT.md).
package/package.json CHANGED
@@ -1,8 +1,25 @@
1
1
  {
2
2
  "name": "captions.js",
3
+ "version": "0.5.0",
3
4
  "private": false,
5
+ "license": "MIT",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "https://github.com/maskin25/captions.js"
9
+ },
4
10
  "description": "A cross-platform captions engine for client- and server-side video processing — ideal for AI video tools, editors, and streaming apps",
5
- "version": "0.3.0",
11
+ "keywords": [
12
+ "captions",
13
+ "subtitles",
14
+ "video",
15
+ "streaming",
16
+ "transcription",
17
+ "AI",
18
+ "machine learning",
19
+ "ffmpeg",
20
+ "client-side",
21
+ "server-side"
22
+ ],
6
23
  "main": "dist/index.js",
7
24
  "module": "dist/index.mjs",
8
25
  "types": "dist/index.d.ts",