Skip to content

Commit

Permalink
docs: improve README.md clarity and structure
Browse files Browse the repository at this point in the history
  • Loading branch information
shanejonas committed Dec 15, 2024
1 parent 1f9987b commit c525ef9
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
# Using nvm
# Node Version Management with 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 **Node Version Manager (nvm)** for efficient management of Node.js versions. Follow the instructions below to ensure you are using the correct version for this project.

## Setting Up NVM

### 1. Use the Correct Node.js Version

To switch to the appropriate Node.js version specified in the project, execute the following command in the root directory of the repository and within 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:
### 2. Install the Required Node.js Version

If you find that the required version is not installed, you can easily install it by running:

```sh
nvm install
```

## Summary

Using `nvm` ensures that you are working with the correct Node.js version, which helps maintain consistency across development environments. Make sure to run these commands whenever you start working on the project.

0 comments on commit c525ef9

Please sign in to comment.