From 54b4cb3033852c7ce5def6b540cfe9ce48cdfa99 Mon Sep 17 00:00:00 2001 From: Jonghakseo Date: Thu, 19 Oct 2023 02:23:21 +0900 Subject: [PATCH] docs: Revised readme to prioritize pnpm --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a2f586057..2e4206769 100755 --- a/README.md +++ b/README.md @@ -56,15 +56,16 @@ This boilerplate is made for creating chrome extensions using React and Typescri 1. Clone this repository. 2. Change `name` and `description` in package.json => **Auto synchronize with manifest** -3. Run `yarn install` or `npm i` (check your node version >= 16.6, recommended >= 18) +3. Install pnpm globally: `npm install -g pnpm` (check your node version >= 16.6, recommended >= 18) +4. Run `pnpm install` ## And next, depending on the needs: ### For Chrome: 1. Run: - - Dev: `yarn dev` or `npm run dev` - - Prod: `yarn build` or `npm run build` + - Dev: `pnpm dev` or `npm run dev` + - Prod: `pnpm build` or `npm run build` 2. Open in browser - `chrome://extensions` 3. Check - `Developer mode` 4. Find and Click - `Load unpacked extension` @@ -73,8 +74,8 @@ This boilerplate is made for creating chrome extensions using React and Typescri ### For Firefox: 1. Run: - - Dev: `yarn dev:firefox` or `npm run dev:firefox` - - Prod: `yarn build:firefox` or `npm run build:firefox` + - Dev: `pnpm dev:firefox` or `npm run dev:firefox` + - Prod: `pnpm build:firefox` or `npm run build:firefox` 2. Open in browser - `about:debugging#/runtime/this-firefox` 3. Find and Click - `Load Temporary Add-on...` 4. Select - `manifest.json` from `dist` folder