From 28618af5ea8fb083de6eae0a13f8a62fc6a02cbf Mon Sep 17 00:00:00 2001 From: Aditya Kode <105551807+adityakode@users.noreply.github.com> Date: Tue, 4 Apr 2023 23:46:37 +0530 Subject: [PATCH] Updated Readme Updated Readme --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 89d3f714..894fc0dc 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,19 @@ -## Getting Started +# Shardeum-website -First, run the development server: +This repository contains the code for Shardeum website built using the Next.js framework. The live website can be accessed [here](shardeum-website-kappa.vercel.app) -```bash -npm run dev -# or -yarn dev -``` +## Installation +To run the website locally, you need to have Node.js and npm installed on your machine. Once you have those installed, follow these steps: -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +Clone the repository to your local machine. +``` +git clone https://github.com/Shardeum/shardeum-website +``` +- Navigate to the project directory in your terminal. +- Run npm install to install the project's dependencies. +- Run npm run dev to start the development server. +- Once the server is running, you can access the website in your browser at http://localhost:3000. ## Contribute to Shardeum