gain-io-widget 0.1.0-rc.1

package/README.md

@@ -0,0 +1,91 @@
+# Gain.io Widget
+
+An embeddable booking widget that lets your customers schedule meetings directly from your website. Supports both React (npm) and plain HTML (CDN) integration.
+
+---
+
+## NPM
+
+### Installation
+
+```bash
+npm install gain-io-widget
+# or
+pnpm add gain-io-widget
+```
+
+### Usage
+
+```jsx
+import { GainIoWidget } from 'gain-io-widget';
+
+export default function App() {
+  return <GainIoWidget apiKey="YOUR_API_KEY" />;
+}
+```
+
+The widget renders a floating trigger button fixed to the bottom-right of the page. Clicking it opens the booking flow inline.
+
+### Props
+
+| Prop     | Type     | Required | Description                         |
+| -------- | -------- | -------- | ----------------------------------- |
+| `apiKey` | `string` | Yes      | Your organization's booking API key |
+
+### Peer Dependencies
+
+React 18+ and ReactDOM must be installed in your project.
+
+```bash
+npm install react react-dom
+```
+
+---
+
+## CDN
+
+Add the script tag anywhere in your HTML. The widget initializes itself automatically.
+
+### Auto-init (recommended)
+
+```html
+<script
+  src="https://cdn.jsdelivr.net/npm/gain-io-widget/dist/gain-io-widget.js"
+  data-gain-auto-init
+  data-api-key="YOUR_API_KEY"
+></script>
+```
+
+The widget reads `data-api-key` from the script tag and mounts itself on page load.
+
+### Manual init
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/gain-io-widget/dist/gain-io-widget.js"></script>
+<script>
+  GainIoWidget.init({ apiKey: 'YOUR_API_KEY' });
+</script>
+```
+
+### Destroy
+
+```js
+GainIoWidget.destroy();
+```
+
+Removes the widget container from the DOM entirely.
+
+---
+
+## How It Works
+
+1. The widget authenticates using your `apiKey` against the Gain.io booking API.
+2. Once authenticated, a floating button appears at the bottom-right of the page.
+3. Clicking the button opens a booking flow — date picker → time slot → booking form → confirmation.
+4. All scheduling is handled by Gain.io's backend. No additional setup required on your end.
+
+---
+
+## License
+
+MIT — © Gain Solutions AS