diff --git a/README.md b/README.md index 97fe88e..5eeb5c6 100644 --- a/README.md +++ b/README.md @@ -39,19 +39,37 @@ This repository is subjected to incentives for the community to contribute to th ## Setup -You should install the dependencies using Yarn to deploy this code to a local testnet. The project uses Hardhat as a development environment, which relies on Node.js (Recommended v18.16.0). +You should install the dependencies using Yarn (used in the project) or npm to deploy this code. The project uses Hardhat as a development environment. Which relies on Node.js (Recommended version [v18.16.0](https://nodejs.org/download/release/v18.16.0/)). + +To make sure that NodeJS is installed correctly, open the integrated terminal and run the following command: + +``` +node -v +``` + +### Yarn: + +Install Yarn globally and check if the version appears: ``` npm install --global yarn yarn --version ``` -Later on, install the dependencies using Yarn. +Install the dependencies using Yarn: ``` yarn install ``` +### npm: + +Install the dependencies using npm: + +``` +npm install +``` + ### Environment Variables The project comes with a `.env.example` file. You should rename it to `.env` and fill the variables with your values. Most RPC providers offer free testnet nodes. You can use [Alchemy](https://www.alchemy.com/) or [Infura](https://infura.io/) to get a free node. @@ -75,4 +93,4 @@ yarn deploy ## Contributing -- To know more about how you can contribute [see our notion page](https://blockful.notion.site/Swaplace-Call-for-Contributors-6e4895d2a7264f679439ab2c124603fe). +- To know more about how you can contribute [see our notion page](https://blockful.notion.site/Swaplace-Call-for-Contributors-6e4895d2a7264f679439ab2c124603fe). \ No newline at end of file