@callembed/sdk 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sealby
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,67 @@
-# Temporary Holding Version
+# `@callembed/sdk`
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Embeddable web SDK for [CallEmbed](https://callembed.sealby.me) — headless voice calls plus an optional themable UI.
+
+**Requires Node.js ≥ 20.** Published as ESM (`import` / bundlers). No dual CJS build. From CommonJS, use dynamic `import()`, or `require()` on **Node ≥ 20.19 / ≥ 22.12** (synchronous ESM require). CDN: jsDelivr / unpkg → `dist/callembed.iife.js`.
+
+## Install
+
+```bash
+npm install @callembed/sdk
+```
+
+## Quick start
+
+Matches the [site quickstart](https://callembed.sealby.me/#quickstart) (init + default button):
+
+```ts
+import { CallEmbed } from "@callembed/sdk";
+import { mountButton } from "@callembed/sdk/ui";
+
+CallEmbed.init({
+  publishableKey: "pk_…",
+  // Placeholder — replace with your CallEmbed API origin (see dashboard / deploy docs).
+  // Not a real hostname. Same-origin / reverse-proxy setups may use "".
+  apiBaseUrl: "https://<your-api-host>",
+});
+mountButton("#talk", { queue: "onboarding" });
+```
+
+Use a **publishable** key (`pk_…`) only. Set `apiBaseUrl` to your CallEmbed API origin (or `""` when the page is same-origin / proxied to the API).
+
+### Headless (your own UI)
+
+```ts
+import { CallEmbed } from "@callembed/sdk";
+
+CallEmbed.init({
+  publishableKey: "pk_…",
+  apiBaseUrl: "https://<your-api-host>", // placeholder — your API origin
+});
+
+const call = await CallEmbed.startCall({
+  queue: "onboarding",
+  hidePanel: true,
+  on: {
+    answered: ({ agentIdentity }) => console.log("agent", agentIdentity),
+    ended: () => {},
+    error: ({ code, message }) => console.error(code, message),
+  },
+});
+
+await call.setMuted(true);
+await call.hangUp();
+```
+
+## Locale
+
+When `CallEmbed.init({ locale })` omits `locale`:
+
+- `navigator.language` starting with `zh` → `zh-TW`
+- otherwise → `en`
+
+Pass `locale: "en"` or `locale: "zh-TW"` to override.
+
+## License
+
+MIT