freestyle-sync 0.1.3 → 0.1.5

package/README.md

@@ -6,8 +6,35 @@ Sync your current directory, it's dependencies, and your agent context into a VM
 npx freestyle-sync
 ```
 
-Configure complex sync behavior using plugins.
+Use the SDK when embedding sync inside another CLI/app (no required `freestyle-sync.config.ts` or cache file):
+
 ```ts
+import { defineConfig, sync, type SyncCache } from "freestyle-sync";
+import { gitAuthPlugin } from "@freestyle-sync/auth-git";
+import { nodeNpmPlugin } from "@freestyle-sync/node-npm";
+
+let cache: SyncCache | undefined;
+
+const result = await sync({
+    config: defineConfig({
+        plugins: [gitAuthPlugin(), nodeNpmPlugin()],
+    }),
+    options: {
+        projectRoot: process.cwd(),
+        autoSsh: false,
+    },
+    cache,
+    onCacheUpdate(nextCache) {
+        cache = nextCache;
+    },
+});
+
+console.log("synced VM", result.vmId);
+```
+
+freestyle-sync creates `freestyle-sync.config.mjs` on first run and installs the config dependencies into your project as dev dependencies. Remove the generated config or dependencies if you want to reset it later.
+
+```js
 import { defineConfig } from "freestyle-sync";
 import { claudeAgentPlugin } from "@freestyle-sync/agent-claude";
 import { codexAgentPlugin } from "@freestyle-sync/agent-codex";
@@ -44,5 +71,4 @@ export default defineConfig({
         shellHistoryPlugin(),
     ],
 });
-
 ```