vidpipe 1.3.9 → 1.3.10

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
@@ -512,3 +512,36 @@ Run `vidpipe doctor` to verify your setup.
512
512
 
513
513
  ISC © [htekdev](https://github.com/htekdev)
514
514
 
515
+ ---
516
+
517
+ ## 🧩 SDK Usage
518
+
519
+ VidPipe also ships as a Node.js ESM SDK for programmatic use:
520
+
521
+ ```ts
522
+ import { createVidPipe } from 'vidpipe'
523
+
524
+ const vidpipe = createVidPipe({
525
+ openaiApiKey: process.env.OPENAI_API_KEY,
526
+ outputDir: './recordings',
527
+ })
528
+
529
+ const result = await vidpipe.processVideo('./videos/demo.mp4', {
530
+ skipGit: true,
531
+ })
532
+
533
+ console.log(result.video.videoDir)
534
+ console.log(result.shorts.length)
535
+ ```
536
+
537
+ SDK features include:
538
+
539
+ - `processVideo()` for the full pipeline
540
+ - `ideate()` plus `ideas.*` CRUD helpers
541
+ - `schedule.*` helpers for slots, calendar, and realignment
542
+ - `video.*` helpers for clips, captions, silence detection, variants, and frames
543
+ - `social.generatePosts()` for quick platform-specific drafts
544
+ - `doctor()` and `config.*` for diagnostics and configuration access
545
+
546
+ See [docs/sdk.md](./docs/sdk.md) for the full SDK guide.
547
+