@getsupertab/supertab-js 3.0.0-beta.2

package/README.md

@@ -0,0 +1,46 @@
+# Supertab.js
+
+This package allows [Supertab.js](https://docs.supertab.co/) to be imported as an ES module. It includes TypeScript declarations.
+
+[![npm version](https://img.shields.io/npm/v/@getsupertab/supertab-js.svg?style=flat-square)](https://www.npmjs.com/package/@getsupertab/supertab-js)
+## Installation
+
+Use `npm` to install the Supertab.js module:
+
+```sh
+npm install @getsupertab/supertab-js
+```
+
+## Usage Example
+
+Run the following code in a browser environment, it won't work on the server-side.
+
+```javascript
+import Supertab from "@getsupertab/supertab-js";
+
+const supertab = new Supertab({
+  clientId: "client.xyz",
+});
+
+const { show } = supertab.createPaygate({
+  experienceId: "experience.xyz",
+});
+
+const paygateResult = await show();
+console.log(paygateResult);
+```
+
+This example creates a new Supertab.js instance using the `new Supertab()` constructor.
+Then, the `createPaygate` method is used to create a new paygate.
+The `show` function renders the paygate. Finally, once the user has completed or cancelled the purchase,
+we print the result data to the browser console.
+
+We've put a placeholder client ID and experience ID in this example.
+Replace them with your actual IDs to test this code with your Supertab.js merchant account.
+Each experience has a corresponding client ID and experience ID. You can find them in the [Supertab Business Portal](https://business.supertab.co)
+under "Experiences" -> Pencil icon (edit) -> "Installation" -> "Code Snippet".
+
+## Links
+
+- [Supertab Docs](https://docs.supertab.co/)
+- [Supertab Business Portal](https://business.supertab.co)