veo-sdk 0.1.0 → 0.2.1

package/README.md

@@ -1,4 +1,4 @@
-# @veo/sdk
+# veo-sdk
 
 SDK oficial de Veo para web apps. Captura eventos de analytics y muestra
 guías in-app (tooltips, modales, walkthroughs).
@@ -15,15 +15,18 @@ guías in-app (tooltips, modales, walkthroughs).
 ### npm
 
 ```bash
-pnpm add @veo/sdk
+npm install veo-sdk    # o: pnpm add veo-sdk / yarn add veo-sdk
 ```
 
 ```ts
-import { init } from '@veo/sdk';
+import { init } from 'veo-sdk';
 
+// Solo en el navegador (usa localStorage/DOM). En Next: client component.
 const veo = init({
   apiKey: 'pk_xxx',
-  apiUrl: 'https://api.veo.io',
+  guides: true,   // opt-in: renderiza guías in-app
+  // apiUrl es OPCIONAL: por defecto apunta al backend gestionado de Veo.
+  // Solo se pasa para self-hosted / otra región.
 });
 
 veo.identify({ visitor: { id: 'user_123', traits: { email: 'a@b.com' } } });
@@ -32,17 +35,20 @@ veo.track('button_clicked');
 
 ### CDN (sin bundler)
 
+Cargá `veo.js` desde unpkg y llamá `init` en el `onload` del `<script>`
+(NO uses un stub con cola: el drain del IIFE saltea el `init` encolado):
+
 ```html
-<script src="https://cdn.veo.io/sdk/v1.js"></script>
-<script>
-  veo.init({ apiKey: 'pk_xxx', apiUrl: 'https://api.veo.io' });
-  veo.identify({ visitor: { id: 'user_123' } });
+<script
+  src="https://unpkg.com/veo-sdk@0.2.1/dist/veo.js"
+  onload="window.veo.init({ apiKey: 'pk_xxx', guides: true });
+          window.veo.identify({ visitor: { id: 'user_123' } });">
 </script>
 ```
 
-### Snippet (recomendado)
-
-Ver `snippet/snippet.html` para el snippet copy-paste.
+`apiUrl` es opcional (default = backend gestionado). Fijá la versión (`@0.2.1`)
+para no romperte con un release futuro. También por jsDelivr:
+`https://cdn.jsdelivr.net/npm/veo-sdk@0.2.1/dist/veo.js`.
 
 ## API