From 38d2f9c2652d1c43ffefe88e0c37f01c8833699a Mon Sep 17 00:00:00 2001 From: creations Date: Wed, 4 Jun 2025 10:56:49 -0400 Subject: [PATCH] change readme(s) --- README.md | 24 +++++++++++++----------- packages/vencord-types/HOW2PUB.md | 2 +- packages/vencord-types/README.md | 2 +- src/plugins/devCompanion.dev/index.tsx | 2 +- 4 files changed, 16 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index f9f7103e..292f2035 100644 --- a/README.md +++ b/README.md @@ -240,14 +240,19 @@ sh -c "$(curl -sS https://raw.githubusercontent.com/Equicord/Equicord/refs/heads ### Dependencies -[Git](https://git-scm.com/download) and [Node.JS LTS](https://nodejs.dev/en/) are required. +[Git](https://git-scm.com/download) and [Bun](https://bun.sh/docs/installation) are required. -Install `pnpm`: - -> :exclamation: This next command may need to be run as admin/root depending on your system, and you may need to close and reopen your terminal for pnpm to be in your PATH. +Install Bun: +> :exclamation: This next command may need to be run as admin/root depending on your system, and you may need to close and reopen your terminal for Bun to be in your PATH. +**On macOS and Linux:** ```shell -npm i -g pnpm +curl -fsSL https://bun.sh/install | bash +``` + +**On Windows:** +```shell +powershell -c "irm bun.sh/install.ps1 | iex" ``` > :exclamation: **IMPORTANT** Make sure you aren't using an admin/root terminal from here onwards. It **will** mess up your Discord/Equicord instance and you **will** most likely have to reinstall. @@ -260,21 +265,18 @@ cd Equicord ``` Install dependencies: - ```shell -pnpm install --no-frozen-lockfile +bun install ``` Build Equicord: - ```shell -pnpm build +bun run build ``` Inject Equicord into your client: - ```shell -pnpm inject +bun run inject ``` ## Credits diff --git a/packages/vencord-types/HOW2PUB.md b/packages/vencord-types/HOW2PUB.md index 2085898e..ea16560c 100644 --- a/packages/vencord-types/HOW2PUB.md +++ b/packages/vencord-types/HOW2PUB.md @@ -1,5 +1,5 @@ # How to publish -1. run `pnpm generateTypes` in the project root +1. run `bun generateTypes` in the project root 2. bump package.json version 3. npm publish diff --git a/packages/vencord-types/README.md b/packages/vencord-types/README.md index 0513f870..9cd14c61 100644 --- a/packages/vencord-types/README.md +++ b/packages/vencord-types/README.md @@ -7,5 +7,5 @@ npm i @vencord/types yarn add @vencord/types -pnpm add @vencord/types +bun add @vencord/types ``` diff --git a/src/plugins/devCompanion.dev/index.tsx b/src/plugins/devCompanion.dev/index.tsx index 23d4c6a3..42bbdd30 100644 --- a/src/plugins/devCompanion.dev/index.tsx +++ b/src/plugins/devCompanion.dev/index.tsx @@ -61,7 +61,7 @@ export default definePlugin({ start() { // if we're running the reporter, we need to initws in the reporter file to avoid a race condition - if (!IS_DEV) throw new Error("This plugin requires dev mode to run, please build with pnpm build --dev"); + if (!IS_DEV) throw new Error("This plugin requires dev mode to run, please build with bun build --dev"); initWs(); },