Skip to content

Commit

Permalink
docs: readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Pritish Budhiraja committed Apr 29, 2024
1 parent b07ea94 commit 18dddc3
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .env
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
SDK_ENV="local"
ENV_SDK_URL=""
ENV_BACKEND_URL=""
ENV_LOGGING_URL=""
ENV_LOGGING_URL=""
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 18dddc3

Please sign in to comment.