Update readmes and add bages (#122)

This commit is contained in:
Rahim
2025-10-24 10:46:00 -07:00
committed by GitHub
parent f9dcb12542
commit 40dc067512
6 changed files with 57 additions and 14 deletions
+37 -9
View File
@@ -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
+4 -1
View File
@@ -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
+4 -1
View File
@@ -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
+4 -1
View File
@@ -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
+4 -1
View File
@@ -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
+4 -1
View File
@@ -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