From 18dddc3da1b2713dd9a52992ee070520b57e4fce Mon Sep 17 00:00:00 2001
From: Pritish Budhiraja <1805317@kiit.ac.in>
Date: Mon, 29 Apr 2024 12:57:24 +0530
Subject: [PATCH] docs: readme updated

---
 .env      |  2 +-
 README.md | 21 ++++++++++++++++-----
 2 files changed, 17 insertions(+), 6 deletions(-)

diff --git a/.env b/.env
index cf0272003..27ece2ab5 100644
--- a/.env
+++ b/.env
@@ -1,4 +1,4 @@
 SDK_ENV="local"
 ENV_SDK_URL=""
 ENV_BACKEND_URL=""
-ENV_LOGGING_URL=""
\ No newline at end of file
+ENV_LOGGING_URL=""
diff --git a/README.md b/README.md
index 919d4a17f..597d3fe3a 100644
--- a/README.md
+++ b/README.md
@@ -85,12 +85,23 @@ Ways to get started with Hyperswitch:
 
 Before you start the local setup, you will need an understanding of few keys -
 
-### About Env Configs
+### About Env Configs for Demo App
 
-- `HYPERSWITCH_PUBLISHABLE_KEY` - Publishable key of your Hyperswitch Account. This key will start with `pk_dev_` for local development, `pk_snd_` for sandbox and `pk_prd_` for production.
-- `HYPERSWITCH_SECRET_KEY` - API key of your Hyperswitch Account
-- `HYPERSWITCH_SERVER_URL` - URL of your hosted Hyperswitch Backend server or you can use our Sandbox URL (https://sandbox.hyperswitch.io) or use your backend running locally (eg. http://localhost:8080).
-- `HYPERSWITCH_CLIENT_URL` - URL of your hosted Hyperswitch SDK or you can use our Sandbox URL (https://beta.hyperswitch.io) or use your app running locally (eg http://localhost:9050).
+- **`HYPERSWITCH_PUBLISHABLE_KEY`:** The publishable key of your Hyperswitch account. This key will start with `pk_dev_` for local development, `pk_snd_` for sandbox, and `pk_prd_` for production.
+
+- **`HYPERSWITCH_SECRET_KEY`:** The API key of your Hyperswitch account.
+
+- **`HYPERSWITCH_SERVER_URL`:** The URL of your hosted Hyperswitch backend server. Alternatively, you can use our Sandbox URL (https://sandbox.hyperswitch.io) or specify your backend running locally (e.g., http://localhost:8080).
+
+- **`HYPERSWITCH_CLIENT_URL`:** The URL of your hosted Hyperswitch SDK. You can also use our Sandbox URL (https://beta.hyperswitch.io/v1) or specify your app running locally (e.g., http://localhost:9050).
+
+### About Env Configs for SDK
+
+- **`SDK_ENV`:** Specifies the environment in which the SDK will be running. This could be "local", "integ", "sandbox", or "prod". Different configurations are available for each environment. The default value is "local".
+
+- **`ENV_BACKEND_URL`:** Sets the endpoint for all the APIs used within the SDK to interact with the backend service. If you are running your own backend service, you can configure and specify its endpoint here for local setups.
+
+- **`ENV_LOGGING_URL`:** Specifies a custom logging endpoint where logs generated by the SDK can be sent. This allows you to view and manage logs according to your requirements.
 
 ### Setup Node