diff --git a/README.md b/README.md index 282e31948..bce6673b7 100644 --- a/README.md +++ b/README.md @@ -59,14 +59,11 @@ While the Unified Checkout is pre-optimized for maximum conversions, it does not

⚡️ Quick Start Guide

- - Ways to get started with Hyperswitch: -- Try it in our Sandbox Environment: Fast and easy to - start. +- Try it in our Sandbox Environment: Fast and easy to start. - + - Install in your local system: Configurations and setup required in your system. Suitable if you like to customise the core offering, [learn more](https://github.com/juspay/hyperswitch/blob/main/docs/try_local_system.md) @@ -122,10 +119,26 @@ This step will prompt you to enter 2 details - ### About Env Configs -For ease of development and deployment there are configs in /Hyperswitch-react-demo-app/.env +For ease of development and deployment there are configs in /Hyperswitch-react-demo-app/.env - + +### How to Find Hyperswitch Publishable Key and API Key + +To integrate Hyperswitch into your project, follow these steps: + +1. **Register**: Begin by registering at [Hyperswitch](https://app.hyperswitch.io/register) to gain access to your dashboard. + +2. **Access Your Dashboard**: Once logged in, navigate to your dashboard's home page. + +3. **Find Your Keys**: In the sidebar, locate the "Developers" section, then click on [API Keys](https://app.hyperswitch.io/developer-api-keys). Here, you can generate your API Key. Additionally, your Publishable Key is available within the same section. + +4. **Integration**: After obtaining your keys, add them to your project's environment variables or configuration file for seamless integration. + +The above method is for using our Sandbox Environment. + +If you are running locally our backend, you can use our [Postman Collection](https://github.com/juspay/hyperswitch/blob/main/docs/try_local_system.md#try-out-our-apis) for generating the API Key and Publishable Key. - `HYPERSWITCH_PUBLISHABLE_KEY` - Publishable key of your Hyperswitch Account -- `HYPERSWITCH_SECRET_KEY` - Api key of your Hyperswitch Account +- `HYPERSWITCH_SECRET_KEY` - API key of your Hyperswitch Account - `HYPERSWITCH_SERVER_URL` - URL of your hosted Hyperswitch Backend server - `HYPERSWITCH_CLIENT_URL` - URL of your hosted Hyperswitch SDK - `SELF_SERVER_URL` - URL of your node server (/Hyperswitch-react-demo-app/server.js) diff --git a/docs/imgs/signup-to-hs.svg b/docs/imgs/signup-to-hs.svg deleted file mode 100644 index 064511374..000000000 --- a/docs/imgs/signup-to-hs.svg +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/package.json b/package.json index b66724530..7e350e4b0 100644 --- a/package.json +++ b/package.json @@ -33,7 +33,7 @@ "re:clean": "rescript clean", "re:start": "rescript build -w", "re:format": "rescript format -all", - "start:dev": "npm run re:start & npm run start", + "start:dev": "npm run re:start && npm run start", "start:playground": "npm run postinstall && cd Hyperswitch-React-Demo-App && node promptScript.js && npm run start", "build:playground": "npm run postinstall && cd Hyperswitch-React-Demo-App && node promptScript.js && npm run build", "prepare": "husky install",