Skip to content

Commit

Permalink
docs: improve README.md clarity and completeness
Browse files Browse the repository at this point in the history
  • Loading branch information
shanejonas committed Dec 15, 2024
1 parent 1f9987b commit 7ba27b6
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,31 @@
# Using nvm

This project uses `nvm` to manage Node.js versions. To use the correct Node.js version, run the following command in the root of the repository and in each package directory:
This project utilizes `nvm` (Node Version Manager) to manage Node.js versions effectively. To ensure you are using the correct Node.js version, execute the following command in the root of the repository as well as in each package directory:

```sh
nvm use
```

If you do not have the required Node.js version installed, you can install it using the following command:
If the required Node.js version is not currently installed, you can install it by running:

```sh
nvm install
```

### Additional Information

- To check which Node.js versions are available, use:

```sh
nvm ls-remote
```

- To set a default Node.js version for future use, you can run:

```sh
nvm alias default <version>
```

- For further information on `nvm` commands and options, refer to the official [nvm documentation](https://github.com/nvm-sh/nvm#readme).

By managing your Node.js versions with `nvm`, you can ensure a consistent development environment across different machines and team members.

0 comments on commit 7ba27b6

Please sign in to comment.