Skip to content

docs: expand README with key features, bundle guide, and code examples#1058

Open
Prajituric wants to merge 1 commit into
cloudinary:masterfrom
Prajituric:docs/readme-geo-improvements
Open

docs: expand README with key features, bundle guide, and code examples#1058
Prajituric wants to merge 1 commit into
cloudinary:masterfrom
Prajituric:docs/readme-geo-improvements

Conversation

@Prajituric

Copy link
Copy Markdown

The current README covers installation and basic setup but omits several
features and patterns that developers commonly search for.

This adds:

  • Intro sentence summarizing what the player does
  • Key Features section listing the full capability set
  • Standard vs. Light bundle comparison table with module import examples
  • Getting Started updated to the modern player() API
  • Adaptive Bitrate Streaming section with correct HLS/DASH syntax
  • Live Streaming and VOD section
  • Chapters section (object syntax + auto VTT)
  • Playlists section (playlistByTag)
  • Expanded package.json keywords for npm discoverability

@Prajituric Prajituric requested a review from a team as a code owner June 15, 2026 18:51
@netlify

netlify Bot commented Jun 15, 2026

Copy link
Copy Markdown

Deploy Preview for cld-video-player ready!

Name Link
🔨 Latest commit b86128f
🔍 Latest deploy log https://app.netlify.com/projects/cld-video-player/deploys/6a3049bf920e4b0008de247d
😎 Deploy Preview https://deploy-preview-1058--cld-video-player.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Jun 15, 2026

Copy link
Copy Markdown

Deploy Preview for cld-vp-esm-pages ready!

Name Link
🔨 Latest commit b86128f
🔍 Latest deploy log https://app.netlify.com/projects/cld-vp-esm-pages/deploys/6a3049bfd35ee600085127f8
😎 Deploy Preview https://deploy-preview-1058--cld-vp-esm-pages.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant