@pierre/storage 0.1.4 → 0.2.1

package/README.md

@@ -201,6 +201,34 @@ builder throws a `RefUpdateError` containing the status, reason, and ref details
 > the source branch and omit `expectedHeadSha` so the service clones that tip before applying your
 > changes.
 
+### Apply a pre-generated diff
+
+If you already have a patch (for example, the output of `git diff --binary`) you can stream it to
+the gateway with a single call. The SDK handles chunking and NDJSON streaming just like it does for
+regular commits:
+
+```ts
+const fs = await import('node:fs/promises');
+
+const patch = await fs.readFile('build/generated.patch', 'utf8');
+
+const diffResult = await repo.createCommitFromDiff({
+  targetBranch: 'feature/apply-diff',
+  expectedHeadSha: 'abc123def4567890abc123def4567890abc12345',
+  commitMessage: 'Apply generated API changes',
+  author: { name: 'Diff Bot', email: 'diff@example.com' },
+  diff: patch,
+});
+
+console.log(diffResult.commitSha);
+console.log(diffResult.refUpdate.newSha);
+```
+
+The `diff` field accepts a `string`, `Uint8Array`, `ArrayBuffer`, `Blob`, `File`, `ReadableStream`,
+iterable, or async iterable of byte chunks—the same sources supported by the standard commit
+builder. `createCommitFromDiff` returns a `Promise<CommitResult>` and throws a `RefUpdateError` when
+the server rejects the diff (for example, if the branch tip changed).
+
 ### Streaming Large Files
 
 The commit builder accepts any async iterable of bytes, so you can stream large assets without