Skip to content

Commit 4d57563

Browse files
committed
chore: updated README.md
1 parent a815336 commit 4d57563

1 file changed

Lines changed: 33 additions & 7 deletions

File tree

README.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,36 @@
1-
# imagekit-video-player
1+
ImageKit.io
2+
ImageKit.io Video Player
3+
[![Node CI](https://img.shields.io/badge/Node-CI-blue)](https://github.com/imagekit-developer/imagekit-video-player)
4+
[![npm version](https://img.shields.io/npm/v/@imagekit/video-player.svg)](https://www.npmjs.com/package/@imagekit/video-player)
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6+
[![Twitter Follow](https://img.shields.io/twitter/follow/imagekitio?style=social)](https://twitter.com/imagekitio)
27

3-
## Development
8+
## Introduction
49

10+
ImageKit's video player is an advanced video player built on top of [Video.js 8.20.0](https://videojs.org/guides) delivering enhanced features for a seamless, interactive video experience. It's fully integrated with ImageKit's video delivery and transformation solution.
11+
12+
## Key features
13+
14+
- **Video transformations**: Apply ImageKit video transformations at the player level or per-video level.
15+
- **Adaptive bitrate streaming**: Full support for HLS and MPEG-DASH with automatic generation of streaming representations.
16+
- **Subtitles and chapters**: Easy addition of subtitles, captions, and chapter markers for better video navigation.
17+
- **Player enhancements**: Floating player when scrolled out of view, and seek thumbnails on the progress bar.
18+
- **Custom branding**: Add a clickable logo to brand your video player.
19+
- **Playlists and recommendations**: Create playlists with scrollable widgets or show recommended videos when playback ends.
20+
- **Shoppable Video**: Make videos shoppable by displaying product images alongside videos.
21+
22+
## Installation
23+
24+
You can install the SDK in your project using npm or yarn.
25+
26+
```bash
27+
npm install @imagekit/video-player
528
```
6-
nvm use
7-
corepack enable
8-
yarn set version berry
9-
yarn install
10-
```
29+
30+
## TypeScript support
31+
32+
The SDK is written in TypeScript, offering first-class TypeScript support. Enjoy excellent type safety and IntelliSense in your IDE. You can use it in your TypeScript projects without any additional configuration.
33+
34+
## Documentation
35+
36+
Refer to the [ImageKit official documentation](https://docs.imagekit.io/video-player/overview) for more details on how to use the SDK.

0 commit comments

Comments
 (0)