From 9baf9c1d328120e36e9852a104fe845e19f0e623 Mon Sep 17 00:00:00 2001
From: Mit Suthar <meetsuthar64@gmail.com>
Date: Thu, 14 Mar 2024 09:36:56 -0400
Subject: [PATCH] Updated embedded-component readme

---
 apps/embedded-catalog/react/README.md | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/apps/embedded-catalog/react/README.md b/apps/embedded-catalog/react/README.md
index 656273243..c1e8f2e20 100644
--- a/apps/embedded-catalog/react/README.md
+++ b/apps/embedded-catalog/react/README.md
@@ -1,7 +1,7 @@
 
 ## Embedded Catalog of Providers (React)
 
-It is a React component aimed to be used in any of your pages so end-users can connect their 3rd parties in 1-click !
+It is a React component aimed to be used in any of your pages so end-users can connect their 3rd parties in 1-click!
 
 ## Installation
 
@@ -32,12 +32,15 @@ import PanoraProviderCard from "@panora/embedded-card-react";
 
 ## Use the component
 
+- The `optionalApiUrl` is an optional prop to use the component with the self-hosted version of Panora.
+
 ```bash
     <PanoraProviderCard 
-    name={"hubspot"} # name of the provider  
-    projectId={"c9a1b1f8-466d-442d-a95e-11cdd00baf49"} # the project id tied to your organization
-    returnUrl={"https://acme.inc"} # the url you want to redirect users to after the connection flow is successful
-    linkedUserId={"b860d6c1-28f9-485c-86cd-fb09e60f10a2"}  # the linked id of the user if already created in Panora system or user's info in your system
+    name={"hubspot"} // name of the provider  
+    projectId={"c9a1b1f8-466d-442d-a95e-11cdd00baf49"} // the project id tied to your organization
+    returnUrl={"https://acme.inc"} // the url you want to redirect users to after the connection flow is successful
+    linkedUserId={"b860d6c1-28f9-485c-86cd-fb09e60f10a2"}  // the linked id of the user if already created in Panora system or user's info in your system
+    optionalApiUrl={"http://localhost:3000"} // Only add this prop to use the component with a self-hosted version of Panora. Without this prop, the component uses the cloud version of Panora.
     />
 ```