@stringpush/sdk 0.1.1 → 0.2.0

package/README.md

@@ -1,6 +1,6 @@
 # @stringpush/sdk
 
-Framework-agnostic plain JavaScript SDK for the Translation Platform.
+Framework-agnostic plain JavaScript SDK for StringPush.
 
 ## Install
 
@@ -18,8 +18,8 @@ await init({
   environment: "staging",
   locale: "en",
   apiKey: "trt_…",
-  apiBaseUrl: "http://localhost:3000",
-  origin: "http://localhost:5173",
+  apiBaseUrl: "https://api.platform.stringpush.com",
+  origin: "https://your-app.example.com",
   onLocaleChange: () => app.rerender(),
   onTranslationsUpdated: () => app.rerender(),
 });
@@ -46,13 +46,13 @@ Enable when your plan includes MAU metering. No PII is sent — only a stable ha
 
 `t(key, values)` supports ICU MessageFormat (plural, select) and `{name}` interpolation via `intl-messageformat`. Configure missing-key behavior with `missingKeyFallback` (`key`, `default_message`, or `empty`) and optional `defaultMessages` at init.
 
-See [examples/vanilla](../../examples/vanilla/) for a runnable demo.
+Try the [hosted sample app](https://sample.platform.stringpush.com) or follow [Getting started](https://docs.platform.stringpush.com/getting-started).
 
 ### Staging vs production
 
 Pass `environment: "staging"` or `environment: "production"` in `init()`. The manifest and bundle URLs are scoped per environment (`/bundles/{projectId}/staging/…` vs `…/production/…`). Use **staging** for pre-release copy and overlay edit mode; use **production** for live customer traffic after promote + publish in admin.
 
-Overlay edit mode is intended for **staging** only unless your organization explicitly enables production overlay (see platform `docs/CONTEXT.md` D-014).
+Overlay edit mode is intended for **staging** only unless your organization explicitly enables production overlay in admin Settings (Business+).
 
 ## Edit mode (staging overlay)
 
@@ -111,9 +111,11 @@ While edit mode is active, the overlay WebSocket applies `translation.updated` (
 
 - **Runtime key** (`trt_…`): read-only; safe in customer frontends; restrict via application **allowed domains**.
 - **Edit token**: short-lived; overlay/write only; never commit or ship in production bundles.
-- **Environment**: use `staging` for overlay QA; production edit requires the organization to enable **production overlay** in admin Settings (Business+), or the API env `EDIT_ON_PRODUCTION_ALLOWED=true` for local ops.
+- **Environment**: use `staging` for overlay QA; production edit requires **production overlay** enabled in admin Settings (Business+).
 - **Origin**: set `origin` in `init()` to match an allowlisted domain (defaults to `window.location.origin`).
 
+Report vulnerabilities to [security@stringpush.com](mailto:security@stringpush.com).
+
 ## Troubleshooting
 
 | Symptom | What to check |
@@ -125,10 +127,10 @@ While edit mode is active, the overlay WebSocket applies `translation.updated` (
 | `environment does not match` | `init({ environment })` must match the edit session environment |
 | `401` on overlay save | Edit JWT expired — re-issue via `POST /v1/auth/edit-session` |
 | `409` on save | Another editor saved first — use Reload in the panel |
-| Live updates missing | Realtime gateway + `REDIS_URL`; same project/environment |
+| Live updates missing | Confirm staging overlay and realtime are enabled for your org; same project/environment as the edit session |
 | CORS errors on manifest or overlay | API must allow your origin; add hostname to application **allowed domains** |
 | CORS errors on bundle CDN | Hosted CDN allows `*`; SDK omits runtime key on cross-origin bundle URLs. BYO CDN: set `Access-Control-Allow-Origin: *` (or your origins) on bundle GET |
 
-Full staging setup: [docs/integration/overlay-staging.md](../../docs/integration/overlay-staging.md).
+Full staging setup: [Staging overlay](https://docs.platform.stringpush.com/integration/overlay-staging).
 
-See [docs/big-picture.md](../../docs/big-picture.md) for the full integration model.
+See [Concepts overview](https://docs.platform.stringpush.com/concepts/overview) for the full integration model.

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@stringpush/sdk",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Plain JS SDK for in-context translation",
+  "homepage": "https://docs.platform.stringpush.com/getting-started",
+  "bugs": {
+    "url": "https://stringpush.com/support",
+    "email": "support@stringpush.com"
+  },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/StringPush/translations.git",
-    "directory": "packages/sdk"
-  },
   "type": "module",
   "main": "./dist/index.umd.cjs",
   "module": "./dist/index.mjs",