Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #155

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update readme #155

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4057f8e
chore: update readme with info about demo and installation
irina-baeva Jan 15, 2025
eac17b4
chore: add info about npm token
irina-baeva Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,36 @@

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.

### 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:

```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:
Expand Down