@sylphx/sdk 0.3.2 → 0.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -407,13 +407,23 @@ import type { AuthResult } from '@sylphx/sdk/nextjs'
407
407
 
408
408
  ---
409
409
 
410
- ## Self-Hosting
410
+ ## Self-Hosting / Custom Deployment
411
411
 
412
- If you're running your own Sylphx Platform deployment:
412
+ If you're running your own Sylphx Platform deployment, configure the base URL via the CLI:
413
413
 
414
414
  ```bash
415
- # .env.local only needed for self-hosting
416
- SYLPHX_PLATFORM_URL=https://platform.your-domain.com
415
+ SYLPHX_API_URL=https://platform.your-domain.com sylphx deploy
417
416
  ```
418
417
 
419
- You will not need this if you're using the hosted platform at [sylphx.com](https://sylphx.com).
418
+ Or in the SDK via `projectRef`:
419
+
420
+ ```ts
421
+ import { createConfig } from '@sylphx/sdk'
422
+ const config = createConfig({
423
+ secretKey: process.env.SYLPHX_SECRET_KEY!,
424
+ projectRef: 'your-project-ref', // from Platform console
425
+ })
426
+ ```
427
+
428
+ > **Note:** `SYLPHX_PLATFORM_URL` has been removed (was deprecated). Use `projectRef` instead.
429
+ > If using hosted Sylphx at [sylphx.com](https://sylphx.com), no additional config is needed.