Skip to content

Commit 66e2172

Browse files
docs: update readme
1 parent 45990d8 commit 66e2172

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,8 @@ const differ = new GitLoomDiff({
153153
outputDir: 'custom-dir',
154154
exclusions: ['*.log'],
155155
diffFormat: 'side-by-side',
156-
darkMode: false
156+
darkMode: false,
157+
mode: 'pr'
157158
});
158159

159160
await differ.run('main', 'feature/branch');
@@ -165,23 +166,27 @@ await differ.run('main', 'feature/branch');
165166
// Code Review Tool Integration
166167
async function generateReviewDiff(prNumber) {
167168
const differ = new GitLoomDiff({
168-
outputDir: `pr-${prNumber}-diff`
169+
outputDir: `pr-${prNumber}-diff`,
170+
mode: 'pr'
169171
});
170172
await differ.run('main', `pr-${prNumber}`);
171173
}
172174

173175
// Git Hook Integration
174176
async function preCommitHook() {
175-
const differ = new GitLoomDiff();
177+
const differ = new GitLoomDiff({
178+
mode: 'commit'
179+
});
176180
await differ.run('HEAD', '--staged');
177181
}
178182

179-
// CI/CD Pipeline
180-
async function generatePRDiff() {
183+
// Tag Release Comparison
184+
async function compareReleases(oldTag, newTag) {
181185
const differ = new GitLoomDiff({
186+
mode: 'tag',
182187
exclusions: ['*.lock', 'dist/*']
183188
});
184-
await differ.run(process.env.TARGET_BRANCH, process.env.PR_BRANCH);
189+
await differ.run(newTag, oldTag);
185190
}
186191
```
187192

0 commit comments

Comments
 (0)