Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.76 KB

README.md

File metadata and controls

45 lines (30 loc) · 1.76 KB
Raw

Video Ambilight 🌈✨

React Ambilight Preview

📖 About the Project

This project provides a React component for creating Ambilight effects with YouTube videos or HTML video elements. It also includes different demos and an example of the component integration in various environments like plain HTML and Next.js.

🚀 Getting Started

To get started with the react-ambilight component, you can install it via npm using the following command:

npm install react-ambilight

Please refer to the package README for detailed installation and usage instructions.

https://www.npmjs.com/react-ambilight

📂 Project Structure

The project is organized into the following directories:

  • docs/: Contains demo projects showcasing the use of the Ambilight component in different environments.
    • canvas/: A demo using a simple HTML5 <canvas> element.
    • images/: Contains images used in the demos.
    • nextjs/: A demo for integrating the component in a Next.js project.
    • youtube/: A demo for integrating the component with YouTube videos.
  • packages/: Contains the react-ambilight component package for NPM distribution.
    • react-ambilight/: The React component package. This can be published to NPM and used in any React project.
    • It also includes configuration files for building and distributing the package.
  • LICENSE: The project's license file.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

💻 Made with love by Bruno