From 07fde5d9097140c7b6fd3f3c5c97d01cee410f0f Mon Sep 17 00:00:00 2001 From: Super User Date: Fri, 2 Aug 2024 03:20:11 -0400 Subject: [PATCH] Add requirements --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 63c6381..e8754e0 100644 --- a/README.md +++ b/README.md @@ -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 | |--------------------|--------------|-------|-----|------------|----------------|-------|