Skip to content

Commit cb1330a

Browse files
authored
docs(readme): add status bar blame and diagnostics features (#68)
Add documentation for: - Status Bar Blame feature with real-time updates - Customizable format template placeholders - Status Bar Settings configuration options - Diagnostics settings for log level control
1 parent 3d5f35d commit cb1330a

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,15 @@ A visual indicator in the editor margin showing commit history **at a glance**.
3636
- 📋 Click to copy commit SHA
3737
- 🔎 Hover for commit details
3838

39+
### 📍 Status Bar Blame
40+
41+
See blame info for the **current line** right in the Visual Studio status bar — updates instantly as you navigate!
42+
43+
-**Real-time updates** — blame follows your cursor
44+
- 🎛️ **Customizable format** — choose what to display with `{author}`, `{date}`, `{message}`, `{sha}` placeholders
45+
- 📅 **Relative or absolute dates** — "2 days ago" or "1/21/2026"
46+
- ✂️ **Auto-truncate** — configurable max length keeps your status bar tidy
47+
3948
### 🔮 What's Next?
4049

4150
Check out our [issues list](https://github.com/CodingWithCalvin/VS-GitRanger/issues) to see what features are planned and vote on what you'd like to see next!
@@ -92,6 +101,23 @@ Configure Git Ranger via **Tools → Options → Git Ranger**
92101
| Gutter Width | Width in pixels | `40` |
93102
| Show Age Bars | Visual age indicators |`true` |
94103

104+
### 📍 Status Bar Settings
105+
106+
| Setting | Description | Default |
107+
|---------|-------------|---------|
108+
| Enable Status Bar Blame | Show blame in status bar |`true` |
109+
| Format | Template with `{author}`, `{date}`, `{message}`, `{sha}` | `{author}, {date} • {message}` |
110+
| Use Relative Dates | Show "2 days ago" vs absolute date |`true` |
111+
| Max Length | Truncate long messages (0 = unlimited) | `100` |
112+
113+
### 🔧 Diagnostics
114+
115+
| Setting | Description | Default |
116+
|---------|-------------|---------|
117+
| Log Level | Output pane verbosity: `None`, `Error`, `Info`, `Verbose` | `Error` |
118+
119+
*Logs are written to the "Git Ranger" output pane in Visual Studio.*
120+
95121
---
96122

97123
## 📋 Requirements

0 commit comments

Comments
 (0)