From 40dc067512e354b61859c0002f5d9a7a8ac29739 Mon Sep 17 00:00:00 2001 From: Rahim Date: Fri, 24 Oct 2025 10:46:00 -0700 Subject: [PATCH] Update readmes and add bages (#122) --- README.md | 46 ++++++++++++++++++++++++++++++++-------- packages/core/README.md | 5 ++++- packages/html/README.md | 5 ++++- packages/icons/README.md | 5 ++++- packages/react/README.md | 5 ++++- packages/utils/README.md | 5 ++++- 6 files changed, 57 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 6ba16ac9..b29eace4 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ # Video.js v10 +[![package-badge]][package] +[![discord-badge]][discord] [![pnpm](https://img.shields.io/badge/maintained%20with-pnpm-cc00ff.svg)](https://pnpm.io/) -Modern, modular, and composable media player framework for web, React, and React Native. +Modern, modular, and composable media player framework for Web and React. 🚧 Note to new comers 🚧 @@ -11,22 +13,48 @@ Modern, modular, and composable media player framework for web, React, and React Thanks for checking out the project! It's in its early stages and currently a mix of protoyping and early structure pointing in the direction we want to go with Video.js v10 (so be kind 🙏). -## Get up to speed - - Read the [v10 discussion topic](https://github.com/videojs/video.js/discussions/9035) - Watch [Heff's recent presentation](https://players.brightcove.net/3737230800001/eyILA5XG7K_default/index.html?videoId=6379311036112) - More roadmap and architecture docs to come... -## How you can help currently +## Documentation -- Run the React and HTML demos -- Give us feedback in a github issue on: - - The aesthetics of the player(s) - - The initial embed code and component structure - - The general direction +If you'd like to get started and learn more, you can find our documentation on our website: + +- [Website][site] +- [Documentation][docs] + +## Community + +If you need help with anything related to Video.js 10, or if you'd like to casually chat with other +members: + +- [Join Discord Server][discord] +- [See GitHub Discussions][gh-discussions] + +### How can I help? + +Join our community channels above and give us feedback! Keep in mind this is a technical preview +and we're working on a lot of polish over the coming months. Feedback on any of the following +would help us al ot: + +- Player skin designs +- Architecture and general approach +- Initial embed code and component structure +- Package structure and exports +- Repo, workspace, contributor guides +- Component structures and APIs ## License [Apache-2.0](./LICENSE) Copyright (c) Video.js Contributors + +[site]: http://v10.videojs.org +[docs]: http://v10.videojs.org/docs +[package]: https://www.npmjs.com/package/@videojs/core +[package-badge]: https://img.shields.io/npm/v/@videojs/core/next?label=@videojs/core@next +[discord]: https://discord.gg/b664Gq3pdy +[discord-badge]: https://img.shields.io/discord/507627062434070529?color=%235865F2&label=%20&logo=discord&logoColor=white +[gh-discussions]: https://github.com/muxinc/vjs-10-monorepo/discussions diff --git a/packages/core/README.md b/packages/core/README.md index 8c6bc633..d7c4e22f 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -1,6 +1,6 @@ # @videojs/core -[![npm](https://img.shields.io/badge/npm-%40vjs--10%2Fcore-blue)](https://www.npmjs.com/package/@videojs/core) +[![package-badge]][package] > **⚠️ Technical Preview - SUBJECT TO CHANGE** Not recommended for production use. @@ -13,3 +13,6 @@ packages. These are foundational building blocks used by platform-specific imple ## License [Apache-2.0](./LICENSE) + +[package]: https://www.npmjs.com/package/@videojs/core +[package-badge]: https://img.shields.io/npm/v/%40videojs%2Fcore%40next diff --git a/packages/html/README.md b/packages/html/README.md index 465349aa..df2b707c 100644 --- a/packages/html/README.md +++ b/packages/html/README.md @@ -1,6 +1,6 @@ # @videojs/html -[![npm](https://img.shields.io/badge/npm-%40vjs--10%2Fcore-blue)](https://www.npmjs.com/package/@videojs/html) +[![package-badge]][package] > **⚠️ Technical Preview - SUBJECT TO CHANGE** Not recommended for production use. @@ -11,3 +11,6 @@ ## License [Apache-2.0](./LICENSE) + +[package]: https://www.npmjs.com/package/@videojs/html +[package-badge]: https://img.shields.io/npm/v/%40videojs%2Fhtml%40next diff --git a/packages/icons/README.md b/packages/icons/README.md index b761799b..60a7b17f 100644 --- a/packages/icons/README.md +++ b/packages/icons/README.md @@ -1,6 +1,6 @@ # @videojs/icons -[![npm](https://img.shields.io/badge/npm-%40vjs--10%2Fcore-blue)](https://www.npmjs.com/package/@videojs/icons) +[![package-badge]][package] > **⚠️ Technical Preview - SUBJECT TO CHANGE** Not recommended for production use. @@ -13,3 +13,6 @@ SVG assets that platform-specific packages transform into their respective compo ## License [Apache-2.0](./LICENSE) + +[package]: https://www.npmjs.com/package/@videojs/icons +[package-badge]: https://img.shields.io/npm/v/%40videojs%2Ficons%40next diff --git a/packages/react/README.md b/packages/react/README.md index 0f7fb3bb..2c51aac1 100644 --- a/packages/react/README.md +++ b/packages/react/README.md @@ -1,6 +1,6 @@ # @videojs/react -[![npm](https://img.shields.io/badge/npm-%40vjs--10%2Fcore-blue)](https://www.npmjs.com/package/@videojs/react) +[![package-badge]][package] > **⚠️ Technical Preview - SUBJECT TO CHANGE** Not recommended for production use. @@ -13,3 +13,6 @@ video and audio players with React. ## License [Apache-2.0](./LICENSE) + +[package]: https://www.npmjs.com/package/@videojs/react +[package-badge]: https://img.shields.io/npm/v/%40videojs%2Freact%40next diff --git a/packages/utils/README.md b/packages/utils/README.md index ec5521e0..b4cd3db4 100644 --- a/packages/utils/README.md +++ b/packages/utils/README.md @@ -1,9 +1,12 @@ # @videojs/utils -[![npm](https://img.shields.io/badge/npm-%40vjs--10%2Fcore-blue)](https://www.npmjs.com/package/@videojs/utils) +[![package-badge]][package] > **⚠️ Technical Preview - SUBJECT TO CHANGE** Not recommended for production use. ## License [Apache-2.0](./LICENSE) + +[package]: https://www.npmjs.com/package/@videojs/utils +[package-badge]: https://img.shields.io/npm/v/%40videojs%2Futils%40next