Skip to content

Commit c69d00d

Browse files
ishikawa-proclaude
andcommitted
docs: enhance README with visual examples and feature showcase
- Add centered logo header with resized logo image - Add "What You Can Do" section with screenshot placeholders - Create docs/images directory for documentation assets - Update features list to include comment functionality - Add visual examples for diff viewing, comments, and AI integration 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent aa98256 commit c69d00d

File tree

5 files changed

+25
-2
lines changed

5 files changed

+25
-2
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,36 @@
1-
# Git Diff Viewer (Electron)
1+
<div align="center">
2+
<img src="docs/images/logo.png" alt="Git Diff Viewer Logo" width="128" height="128">
3+
4+
# Git Diff Viewer (Electron)
5+
6+
A rich desktop application for viewing Git diffs between branches with syntax highlighting.
7+
</div>
28

3-
A rich desktop application for viewing Git diffs between branches with syntax highlighting.
9+
## What You Can Do
10+
11+
### GitHub-Style Diff Viewing
12+
View your Git changes in a familiar GitHub-style interface with syntax highlighting and file tree navigation.
13+
14+
![GitHub-style diff view](docs/images/diff-view.png)
15+
16+
### Add Comments to Code Changes
17+
Add comments directly to specific lines of code changes, making it easy to review and annotate your diffs.
18+
19+
![Comment functionality](docs/images/comments.png)
20+
21+
### Copy Comments for AI Instructions
22+
Easily copy your comments and use them as instructions for AI tools to help implement code changes.
23+
24+
![Copy comments for AI](docs/images/copy-comments.png)
425

526
## Features
627

728
- 🖥️ **Desktop App**: Native desktop application built with Electron
829
- 🎨 **Syntax Highlighting**: Code is highlighted based on file type
930
- 📁 **File Tree**: Navigate through changed files easily
1031
- 🔄 **Branch Comparison**: Compare any two branches
32+
- 💬 **Code Comments**: Add comments to specific lines in diffs
33+
- 📋 **Copy Comments**: Export comments for use with AI tools
1134
- 📊 **Change Statistics**: View insertions, deletions, and file counts
1235
- 🎯 **Modern UI**: Clean and responsive design with Tailwind CSS
1336
- 🔒 **Local Access**: Direct access to local Git repositories

docs/images/comments.png

257 KB
Loading

docs/images/copy-comments.png

35.2 KB
Loading

docs/images/diff-view.png

302 KB
Loading

docs/images/logo.png

12.4 KB
Loading

0 commit comments

Comments
 (0)