Add requirements

This commit is contained in:
Super User 2024-08-02 03:20:11 -04:00
parent 8db6816312
commit 07fde5d909

View file

@ -5,19 +5,25 @@ MinPluto is a modern privacy frontend for YouTube and Twitch(planned) giving you
___
## Requirements
The package manager that you need to use with MinPluto must be [Bun](https://bun.sh/) since it appears to be the most functional option for this project. Attempting to use another package manager like Yarn or PNPM may cause issues, view [Package Managers](#package-managers) in the [Compatibility](#compatibility) section. There seems to be some issues related to both `@astrojs/vue` and `@iconoir/vue`.
Bun is much faster for installation time and it works standalone, meaning you don't need NodeJS installed for it to work.
___
## Compatibility
### Package Managers
| Package Manager | Install Packages | Run Project |
|---------------------|------------------|-------------|
| NPM | ❌ | ❌ |
| PNPM | ✅ | ❌ |
| PNPM | | ❌ |
| Bun | ✅ | ✅ |
| Yarn v1 | ✅ | ❌ |
| Yarn v3 | ✅ | ❌ |
| Yarn v4 | ✅ | ❌ |
> There appears to be an issue with the `@astrojs/vue` package with all package manager, except for Bun.
### Web Browsers
| Browser | Live Streams |Player | CSS | JavaScript | Account System | Embed |
|--------------------|--------------|-------|-----|------------|----------------|-------|