1- # Git Markdown Diff Tool
1+ # GitLoom Diff
22
3- [ ![ npm version] ( https://badge.fury.io/js/git-markdown- diff.svg )] ( https://www.npmjs.com/package/git-markdown -diff )
3+ [ ![ npm version] ( https://badge.fury.io/js/gitloom- diff.svg )] ( https://www.npmjs.com/package/gitloom -diff )
44[ ![ License: MIT] ( https://img.shields.io/badge/License-MIT-yellow.svg )] ( https://opensource.org/licenses/MIT )
5- [ ![ Node.js Version] ( https://img.shields.io/node/v/git-markdown -diff.svg )] ( https://nodejs.org )
5+ [ ![ Node.js Version] ( https://img.shields.io/node/v/gitloom -diff.svg )] ( https://nodejs.org )
66
77** Stop squinting at those git provider diff views.** Generate beautiful, searchable, IDE-friendly git diffs in markdown format.
88
1111## Quick Start
1212
1313``` bash
14- npm install -g git-markdown -diff
14+ npm install -g gitloom -diff
1515
1616# Basic usage
17- git-markdown -diff
17+ gitloom -diff
1818
1919# Compare branches
20- git-markdown -diff -s feature/awesome -e main
20+ gitloom -diff -s feature/awesome -e main
2121```
2222
2323## Why You'll Love This
@@ -96,19 +96,19 @@ GitHub, GitLab, or any other git provider diffs can be hard to parse - especiall
9696
9797``` bash
9898# Compare commits
99- git-markdown -diff -s abc123 -e def456
99+ gitloom -diff -s abc123 -e def456
100100
101101# Compare branches
102- git-markdown -diff -s feature/branch -e main
102+ gitloom -diff -s feature/branch -e main
103103
104104# Compare tags
105- git-markdown -diff -s v1.1.0 -e v1.0.0
105+ gitloom -diff -s v1.1.0 -e v1.0.0
106106
107107# Compare with remote
108- git-markdown -diff -s origin/main -e main
108+ gitloom -diff -s origin/main -e main
109109
110110# Compare staged changes
111- git-markdown -diff -s HEAD -e --staged
111+ gitloom -diff -s HEAD -e --staged
112112```
113113
114114### Configuration
@@ -128,13 +128,13 @@ Options:
128128
129129``` bash
130130# Side-by-side diff with custom output
131- git-markdown -diff -s main -e develop -o pr-123-diffs -f side-by-side
131+ gitloom -diff -s main -e develop -o pr-123-diffs -f side-by-side
132132
133133# Exclude patterns
134- git-markdown -diff --exclude " *.test.js" " docs/**"
134+ gitloom -diff --exclude " *.test.js" " docs/**"
135135
136136# Multiple options
137- git-markdown -diff \
137+ gitloom -diff \
138138 -s feature/new-ui \
139139 -e develop \
140140 -o ui-changes \
@@ -146,9 +146,9 @@ git-markdown-diff \
146146## Programmatic Usage
147147
148148``` javascript
149- const GitMarkdownDiff = require (' git-markdown -diff' );
149+ const GitLoomDiff = require (' gitloom -diff' );
150150
151- const differ = new GitMarkdownDiff ({
151+ const differ = new GitLoomDiff ({
152152 outputDir: ' custom-dir' ,
153153 exclusions: [' *.log' ],
154154 diffFormat: ' side-by-side' ,
@@ -163,21 +163,21 @@ await differ.run('main', 'feature/branch');
163163``` javascript
164164// Code Review Tool Integration
165165async function generateReviewDiff (prNumber ) {
166- const differ = new GitMarkdownDiff ({
166+ const differ = new GitLoomDiff ({
167167 outputDir: ` pr-${ prNumber} -diff`
168168 });
169169 await differ .run (' main' , ` pr-${ prNumber} ` );
170170}
171171
172172// Git Hook Integration
173173async function preCommitHook () {
174- const differ = new GitMarkdownDiff ();
174+ const differ = new GitLoomDiff ();
175175 await differ .run (' HEAD' , ' --staged' );
176176}
177177
178178// CI/CD Pipeline
179179async function generatePRDiff () {
180- const differ = new GitMarkdownDiff ({
180+ const differ = new GitLoomDiff ({
181181 exclusions: [' *.lock' , ' dist/*' ]
182182 });
183183 await differ .run (process .env .TARGET_BRANCH , process .env .PR_BRANCH );
0 commit comments