From b622dd7dd5afea933e8aed1f0e8746734631bfef Mon Sep 17 00:00:00 2001 From: Shane Date: Sun, 15 Dec 2024 08:38:22 -0500 Subject: [PATCH] docs: improve README.md clarity and structure --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4de67b8..522ae88 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,33 @@ -# 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 [nvm](https://github.com/nvm-sh/nvm) (Node Version Manager) to manage Node.js versions efficiently. Follow the instructions below to ensure you're using the correct Node.js version. + +## Prerequisites + +Make sure you have `nvm` installed. You can follow the installation instructions on the [nvm GitHub page](https://github.com/nvm-sh/nvm#installing-and-updating). + +## Usage + +### Setting the Node.js Version + +To use the correct Node.js version for this project, navigate to the root of the repository and run: ```sh nvm use ``` -If you do not have the required Node.js version installed, you can install it using the following command: +This command will switch to the version specified in the project's `.nvmrc` file. + +### Installing the Required Node.js Version + +If the required Node.js version is not installed, you can easily install it with the following command: ```sh nvm install ``` + +This will install the version specified in the `.nvmrc` file. + +## Summary + +By using `nvm`, you can ensure that your development environment matches the project's requirements, leading to smoother development and fewer compatibility issues. \ No newline at end of file