Skip to content

Commit 34b698b

Browse files
committed
Sharpen the README story
1 parent a9df523 commit 34b698b

2 files changed

Lines changed: 65 additions & 26 deletions

File tree

‎README.md‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
1-
<div align="center">
2-
<img src="assets/git-why.svg" alt="git-why: ask Git why a line exists" width="760">
1+
<h1 align="center">git-why</h1>
32

4-
[![CI](https://github.com/whatnotbot/git-why/actions/workflows/ci.yml/badge.svg)](https://github.com/whatnotbot/git-why/actions/workflows/ci.yml)
5-
[![License: MIT](https://img.shields.io/badge/license-MIT-2f81f7.svg)](LICENSE)
6-
</div>
3+
<p align="center"><strong>Ask Git why a line exists.</strong></p>
74

8-
`git-why` reads local Git history for one line of code. It prints the commit that last changed the line, earlier line-history commits, and issue references found in commit messages.
5+
<p align="center">
6+
<img src="assets/git-why.svg" alt="A source line, the git why command, and the recorded commit reason" width="960">
7+
</p>
8+
9+
<p align="center">
10+
<a href="https://github.com/whatnotbot/git-why/actions/workflows/ci.yml"><img src="https://github.com/whatnotbot/git-why/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
11+
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-2f81f7.svg" alt="License: MIT"></a>
12+
</p>
13+
14+
Point `git why` at a tracked line. It shows the commit message, earlier edits, and issue references behind that line. Everything stays local.
15+
16+
## Example
917

1018
```console
1119
$ git why src/auth.rs:2

‎assets/git-why.svg‎

Lines changed: 51 additions & 20 deletions
Loading

0 commit comments

Comments
 (0)