From 4057f8eec45281d2cbfc153a02b0d10d323613ae Mon Sep 17 00:00:00 2001 From: Irina Baeva Date: Wed, 15 Jan 2025 11:19:56 +0100 Subject: [PATCH 1/2] chore: update readme with info about demo and installation --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 570b0ca..12f5cf4 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,28 @@ Supertab Browser SDK. -## Installation +## Requirements + +This project uses [bun](https://bun.sh/) as the package manager and runtime. Please ensure you have it installed before proceeding. + +## Demo & Installation + +1. Install dependencies: ```bash -npm install @getsupertab/supertab-browser +bun install ``` +2. Start the demo: + +```bash +bun start +``` + +This will launch a demo where you can see the response examples and test the Supertab Browser SDK. + +3. Note on authentication: Some endpoints in the demo require authentication. Click on the `Auth` button to start the authentication process before using those endpoints. + ## Usage The supertab-browser instance can be initialized in two ways: From eac17b4e5f11a88c57d8a9a0f9b72e5019f1d6ae Mon Sep 17 00:00:00 2001 From: Irina Baeva Date: Wed, 15 Jan 2025 11:23:34 +0100 Subject: [PATCH 2/2] chore: add info about npm token --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 12f5cf4..b1164dd 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,15 @@ Supertab Browser SDK. This project uses [bun](https://bun.sh/) as the package manager and runtime. Please ensure you have it installed before proceeding. -## Demo & Installation +### NPM Token + +To access private packages, you need to set up an NPM_TOKEN in your environment. If you are using the shared token, you can skip this step. + +For more information on setting it up, please refer to the [NPM Token Guide](https://laterpay-supertab-docs.readthedocs-hosted.com/en/latest/developers/guides/local-dev/#npm-token). + +### Development + +After cloning the repository, run the following commands to get started: 1. Install dependencies: