Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve README.md clarity and structure #27

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Loading