Skip to content

Commit

Permalink
docs: Revised readme to prioritize pnpm
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonghakseo committed Oct 18, 2023
1 parent 4c99e60 commit 54b4cb3
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: <a name="chrome"></a>

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`
Expand All @@ -73,8 +74,8 @@ This boilerplate is made for creating chrome extensions using React and Typescri
### For Firefox: <a name="firefox"></a>

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
Expand Down

0 comments on commit 54b4cb3

Please sign in to comment.