From 779f3575bf38239accfd2db472f4121ea69b50c2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9s?= <105802444+kilted-andres@users.noreply.github.com> Date: Wed, 5 Jun 2024 13:06:39 +0200 Subject: [PATCH] chore: upgrade required node version to >=20 (and some other minor improvements) (#492) * fix: update projects description * feat: explain how to start the project locally * chore: upgrade required node version to >=20 * fix: slimmer readme --- README.md | 11 ++++++++++- package.json | 2 +- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c7d5bee0..63b5ebb0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,14 @@ # Link Addresses -The Link Addresses Website acts as a guide to setting up a web3name and as an interface for linking your DID and web3name to any of your account addresses in the Polkadot ecosystem. +The Link Addresses Website acts as an interface for linking your DID and web3name to any of your account addresses in the Polkadot or Ethereum ecosystem. https://linking.trusted-entity.io/ + +## Start the project locally + +1. [Clone the repository ](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository). +2. Install the dependencies by running `yarn install`. +3. On the root directory, copy the `.env.example` to `.env` and customize the variable values to your needs. +4. Start the project by running `yarn dev`. +5. Visit http://localhost:1234/ on any browser on your machine. + This happens mostly automatically. diff --git a/package.json b/package.json index d9a75ee3..c8cac626 100644 --- a/package.json +++ b/package.json @@ -67,6 +67,6 @@ } }, "engines": { - "node": ">=18.20.3" + "node": ">=20.0" } }