From 5248092b275d2a576c6abdf1c99692b2a492ace7 Mon Sep 17 00:00:00 2001
From: Anwer AR <AnwerAR@users.noreply.github.com>
Date: Tue, 27 Aug 2024 12:49:00 +0500
Subject: [PATCH] Update README

---
 README.md | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 64 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index cf9679d..949b16f 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,65 @@
-# checkout-web-sdk-code-demo
 
- - Checkout Web [Documentation](https://checkoutdocs.payoneer.com/docs/getting-started-checkout-web-sdk) 
- - Demo [here](https://optile.github.io/checkout-web-sdk-code-demo/)
\ No newline at end of file
+
+# Checkout Web SDK Code Demo
+
+## Overview
+
+Welcome to the Checkout Web SDK Code Demo! This repository contains a demo application showcasing the Checkout Web SDK, along with its documentation.
+-   **Checkout Web Documentation**: [Read the Docs](https://checkoutdocs.payoneer.com/docs/getting-started-checkout-web-sdk)
+-   **Live Demo**: [View the Demo](https://optile.github.io/checkout-web-sdk-code-demo/)
+
+## Local Development Guide
+
+To set up and run the project locally, follow these steps:
+
+### 1. Clone the Repository
+
+Clone this repository to your local machine:
+
+    git clone https://github.com/optile/checkout-web-sdk-code-demo.git
+
+### 2. Install Dependencies
+
+Navigate to the project directory and install the necessary dependencies:
+
+    npm install
+
+### 3. Run the Development Server
+
+Start the development server to view the project locally:
+
+    npm run dev
+***Note: It's important to note the project runs on port 3000***
+
+### 4. Build the Project
+
+To create a production build of the project, run:
+
+    npm run build
+
+### 5. Preview the Build
+
+To preview the production build locally:
+
+    npm run preview
+
+## Configuration
+
+By default, this demo application uses an internal integration environment to generate list session. You can change the environment by passing `longId` and `env` as URL query parameters.
+
+*Note: More info about generating backend payment session* [here](https://checkoutdocs.payoneer.com/docs/basic-integration-checkout-web-sdk)
+
+**Example Usage:**
+
+    {BASE_URL}/?longId=longId&env=test
+
+### Available Environments
+
+Specify the environment using the `env` parameter. Available options include:
+
+-   `test` - Sandbox environment
+-   `live` - Production environment
+
+## Deployment
+
+This project is automatically deployed to GitHub Pages via GitHub Actions. Any push to the `main` branch triggers the deployment process.