diff --git a/README.md b/README.md index 570b0ca..b1164dd 100644 --- a/README.md +++ b/README.md @@ -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: