diff --git a/.changeset/rotten-parrots-end.md b/.changeset/angry-mugs-fry.md similarity index 53% rename from .changeset/rotten-parrots-end.md rename to .changeset/angry-mugs-fry.md index 41aebe7..b28ed12 100644 --- a/.changeset/rotten-parrots-end.md +++ b/.changeset/angry-mugs-fry.md @@ -2,4 +2,4 @@ "@limeplay/core": patch --- -Minor Fixes, Testing TS Docs +Rolling back version diff --git a/.changeset/purple-games-act.md b/.changeset/purple-games-act.md new file mode 100644 index 0000000..9cf6874 --- /dev/null +++ b/.changeset/purple-games-act.md @@ -0,0 +1,5 @@ +--- +"@limeplay/core": patch +--- + +Patch: Added Readme diff --git a/docs/package.json b/docs/package.json index cc34b95..d3b53bc 100644 --- a/docs/package.json +++ b/docs/package.json @@ -1,6 +1,7 @@ { "name": "@limeplay/docs", - "version": "1.0", + "version": "1.0.1", + "private": true, "scripts": { "dev": "next dev", "build": "next build", diff --git a/package.json b/package.json index 2560b50..3810251 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,8 @@ { - "name": "limetree", + "name": "limeplay", "version": "1.0.0", "description": "", + "private": true, "main": "index.js", "scripts": { "limeplay:dev": "cd packages/limetree && pnpm run dev", diff --git a/packages/limeplay-core/CHANGELOG.md b/packages/limeplay-core/CHANGELOG.md index d740264..b6ad473 100644 --- a/packages/limeplay-core/CHANGELOG.md +++ b/packages/limeplay-core/CHANGELOG.md @@ -1,5 +1,11 @@ # @limeplay/core +## 0.0.0-dev-20230405190848 + +### Patch Changes + +- 58efb3e: Minor Fixes, Testing TS Docs + ## 2.0.1 ### Patch Changes diff --git a/packages/limeplay-core/README.md b/packages/limeplay-core/README.md new file mode 100644 index 0000000..620da99 --- /dev/null +++ b/packages/limeplay-core/README.md @@ -0,0 +1,115 @@ +

+ + + +

+ +

🔰 Build Bullet Proof & Stunning Media Players at Ease

+
+ +

+ Bundle Size + + MIT License + + NPM Downloads + Github Stars + + Discord + +

+ +
+ +Limeplay is a React based component UI library build on top of [Shaka Player]( + https://github.com/shaka-project/shaka-player) that allows you to build stunning, accessible and modern looking Media Players with ease. It exposes several hooks and highly configurable components using which you can build any functional Media Player like Netflix, Youtube, Hulu, Hotstar, without having to worry about the underlying player logic while adhering to accessibility best practices. + +

🚧 This project is still in its early stages and is looking for contributors 🚧

+

🏗️ This project is under Heavy Development, Things might change anytime! 🏗️

+ +
+ +## Table of contents + +- 📋 [Documentation](#documentation) +- 🚀 [Features](#features) +- 📦 [Installation](#installation) +- 💻 [Usage](#usage) +- 👋 [Support](#support) +- 📝 [Contributing](#contributing) +- ⚖️ [License](#license) + +## Documentation + +👉 It's the https://docs.limeplay.me website for the latest version of Limeplay. + +## Features +- To be Added +- To be Added +- To be Added +- To be Added + +## Installation + +To use Limeplay UI components, all you need to do is install the +`@limeplay/core` package and its peer dependencies: + +```sh +$ yarn add @limeplay/core @emotion/react@^11 @emotion/styled@^11 + +# or + +$ npm i @limeplay/react @emotion/react@^11 @emotion/styled@^11 framer-motion@^6 +``` + +## Usage + +To start using the components, please follow these steps: + +1. Wrap your application with the `LimeplayProvider` provided by + **@limeplay/core**. + +```jsx +import { LimeplayProvider } from "@limeplay/core" + +// Do this at the root of your application +function App({ children }) { + return {children} +} +``` + +2. Import the components you want to use from **@limeplay/core** and wrap them + with the `PlayerWrapper` component. + +```jsx +import { PlayerWrapper, VideoWrapper, ControlsOverlay, PlaybackControl, VolumeControl } from "@limeplay/core" + +function MyFullscreenPlayer() { + return ( + + + + + + + + ) +} +``` + +## Support & Discussion + +More guides on how to get started are available [here](https://docs.limeplay.com/pages/getting-started) +For issues, discussion, and support, please join our [Discord Server](https://discord.gg/ZjXFzqmqjn). + +## Contributing +This project follows the +[all-contributors](https://github.com/all-contributors/all-contributors) +specification. Contributions of any kind welcome! + +## License + +MIT © [WINOFFRG](https://github.com/winoffrg) diff --git a/packages/limeplay-core/package.json b/packages/limeplay-core/package.json index 2ac58d1..a9b978d 100644 --- a/packages/limeplay-core/package.json +++ b/packages/limeplay-core/package.json @@ -1,6 +1,6 @@ { "name": "@limeplay/core", - "version": "2.0.1", + "version": "0.2.3", "description": "React UI library for Shaka Player focused on usability, accessibility, performance and developer experience", "main": "src/index.ts", "files": [