Skip to content

Commit

Permalink
Update contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
mnemitz committed Nov 6, 2024
1 parent 920b13a commit 6463bbd
Showing 1 changed file with 6 additions and 11 deletions.
17 changes: 6 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,13 @@ Welcome to the Speechmatics Javascript SDK! We're open to contributions from any

This monorepo uses [`pnpm`](https://pnpm.io/) as a package manager. You can install it in various ways, but we would recommend using Corepack, which comes bundled with recent NodeJS versions: https://pnpm.io/installation#using-corepack

```
corepack use pnpm@latest
corepack enable pnpm
```

If for some reason that doesn't work, you can also just run

```
npm i -g pnpm
```
### PNPM installation steps

to install `pnpm` globally on your machine.
- If you have PNPM installed already, we recommend removing it from your system with this command: rm -rf $PNPM_HOME
- If using NVM, run `nvm use` in the speechmatics-js-sdk repo, to ensure you're using Node 20.17
- In the `speechmatics-js-sdk/` folder, run `corepack use pnpm@latest`
- Run `corepack enable pnpm`
- Verify `pnpm --version` outputs the same version found in the `packageManager` field of [`package.json`](/package.json)

### Installing dependencies

Expand Down

0 comments on commit 6463bbd

Please sign in to comment.