Skip to content

Commit ff9b75e

Browse files
authored
docs(readme): add emojis, badges, and visual styling (#35)
- Add centered project logo at top - Add shields.io badges for VS version, .NET Framework, and license - Add emojis throughout all sections for visual appeal - Replace hardcoded "coming soon" features with link to issues list - Update author section with clickable badge links - Add star call-to-action footer
1 parent cc8db6f commit ff9b75e

File tree

1 file changed

+105
-59
lines changed

1 file changed

+105
-59
lines changed

README.md

Lines changed: 105 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,148 @@
1-
# Git Ranger
1+
<p align="center">
2+
<img src="src/CodingWithCalvin.GitRanger/Resources/Icons/icon.png" alt="Git Ranger Logo" width="128" />
3+
</p>
24

3-
A visually exciting Git management extension for Visual Studio 2022/2026, bringing GitLens-style functionality with theme-adaptive vibrant colors.
5+
# 🤠 Git Ranger
46

5-
## Features
7+
> *Taming your Git history, one line at a time!* 🐎
68
7-
### Inline Blame Annotations
8-
See who changed each line directly in the editor, with author name, commit date, and message displayed at the end of each line.
9+
[![Visual Studio 2022](https://img.shields.io/badge/Visual%20Studio-2022%20%7C%202026-purple?logo=visualstudio&logoColor=white)](https://visualstudio.microsoft.com/)
10+
[![.NET Framework](https://img.shields.io/badge/.NET%20Framework-4.8-blue?logo=dotnet)](https://dotnet.microsoft.com/)
11+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
912

10-
- Color-coded by author (each contributor gets a unique vibrant color)
11-
- Optional age-based heat map (green = recent, red = old)
12-
- Configurable opacity and display format
13-
- Hover for full commit details
13+
---
14+
15+
A **visually stunning** Git management extension for Visual Studio 2022/2026, bringing GitLens-style functionality with theme-adaptive vibrant colors. 🎨✨
16+
17+
---
18+
19+
## 🚀 Features
20+
21+
### 🔍 Inline Blame Annotations
22+
23+
See who changed each line **directly in the editor** — author name, commit date, and message displayed right at the end of each line!
24+
25+
- 🎨 **Color-coded by author** — each contributor gets a unique vibrant color
26+
- 🔥 **Heat map mode** — green = recent, red = old (optional)
27+
- 👁️ **Configurable opacity** and display format
28+
- 💬 **Hover for full commit details**
29+
30+
### 📊 Blame Gutter Margin
1431

15-
### Blame Gutter Margin
16-
A visual indicator in the editor margin showing commit history at a glance.
32+
A visual indicator in the editor margin showing commit history **at a glance**.
1733

18-
- Age bars showing relative commit age
19-
- Author color indicators
20-
- Click to copy commit SHA
21-
- Hover for commit details
34+
- 📈 Age bars showing relative commit age
35+
- 🎯 Author color indicators
36+
- 📋 Click to copy commit SHA
37+
- 🔎 Hover for commit details
2238

23-
### Planned Features
24-
- **File History** - View all commits affecting the current file
25-
- **Commit Details** - Deep dive into any commit
26-
- **Interactive Git Graph** - Visual branch/merge history (SkiaSharp-powered)
27-
- **Comparison Tools** - Compare with previous revisions
39+
### 🔮 What's Next?
2840

29-
## Installation
41+
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!
42+
43+
---
44+
45+
## 📦 Installation
3046

3147
### From Visual Studio Marketplace
32-
*(Coming soon)*
48+
49+
🚧 *Coming soon!* 🚧
3350

3451
### From Source
35-
1. Clone the repository
36-
2. Open `CodingWithCalvin.GitRanger.sln` in Visual Studio 2022
37-
3. Build the solution
38-
4. The VSIX will be created in the output directory
3952

40-
## Configuration
53+
```bash
54+
# 1. Clone the repository
55+
git clone https://github.com/CodingWithCalvin/VS-GitRanger.git
56+
57+
# 2. Open in Visual Studio 2022
58+
# 3. Build the solution (F5 to debug)
59+
# 4. VSIX will be created in the output directory
60+
```
61+
62+
---
63+
64+
## ⚙️ Configuration
4165

42-
Configure Git Ranger via **Tools > Options > Git Ranger**
66+
Configure Git Ranger via **Tools → Options → Git Ranger**
67+
68+
### 🏷️ Blame Settings
4369

44-
### Blame Settings
4570
| Setting | Description | Default |
4671
|---------|-------------|---------|
47-
| Enable Inline Blame | Show blame at end of lines | `true` |
48-
| Enable Blame Gutter | Show blame in margin | `true` |
49-
| Show Author Name | Display author in inline blame | `true` |
50-
| Show Commit Date | Display date in inline blame | `true` |
51-
| Show Commit Message | Display message in inline blame | `true` |
72+
| Enable Inline Blame | Show blame at end of lines | `true` |
73+
| Enable Blame Gutter | Show blame in margin | `true` |
74+
| Show Author Name | Display author in inline blame | `true` |
75+
| Show Commit Date | Display date in inline blame | `true` |
76+
| Show Commit Message | Display message in inline blame | `true` |
5277
| Date Format | `relative` or custom format string | `relative` |
5378

54-
### Color Settings
79+
### 🎨 Color Settings
80+
5581
| Setting | Description | Default |
5682
|---------|-------------|---------|
5783
| Color Mode | `Author`, `Age`, or `None` | `Author` |
5884
| Max Age (days) | Maximum age for heat map | `365` |
5985

60-
### Display Settings
86+
### 🖥️ Display Settings
87+
6188
| Setting | Description | Default |
6289
|---------|-------------|---------|
6390
| Inline Blame Opacity | Transparency (0.0 - 1.0) | `0.7` |
64-
| Compact Mode | Condensed display format | `false` |
91+
| Compact Mode | Condensed display format | `false` |
6592
| Gutter Width | Width in pixels | `40` |
66-
| Show Age Bars | Visual age indicators | `true` |
93+
| Show Age Bars | Visual age indicators | `true` |
6794

68-
## Requirements
95+
---
6996

70-
- Visual Studio 2022 (17.0) or later
71-
- .NET Framework 4.8
97+
## 📋 Requirements
7298

73-
## Technology Stack
99+
- 💻 Visual Studio 2022 (17.0) or later
100+
- 🔧 .NET Framework 4.8
74101

75-
- **Git Integration**: LibGit2Sharp
76-
- **UI Framework**: WPF
77-
- **Graph Rendering**: SkiaSharp (planned)
78-
- **VS Integration**: Community.VisualStudio.Toolkit
102+
---
79103

80-
## Contributing
104+
## 🛠️ Technology Stack
81105

82-
Contributions are welcome! Please feel free to submit issues and pull requests.
106+
| Component | Technology |
107+
|-----------|------------|
108+
| 🔗 Git Integration | LibGit2Sharp |
109+
| 🎨 UI Framework | WPF |
110+
| 📊 Graph Rendering | SkiaSharp *(planned)* |
111+
| 🔌 VS Integration | Community.VisualStudio.Toolkit |
83112

84-
1. Fork the repository
85-
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
86-
3. Commit your changes (`git commit -m 'Add amazing feature'`)
87-
4. Push to the branch (`git push origin feature/amazing-feature`)
88-
5. Open a Pull Request
113+
---
114+
115+
## 🤝 Contributing
89116

90-
## License
117+
Contributions are welcome! Feel free to submit issues and pull requests. 💪
91118

92-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
119+
1. 🍴 Fork the repository
120+
2. 🌿 Create a feature branch (`git checkout -b feature/amazing-feature`)
121+
3. 💾 Commit your changes (`git commit -m 'feat: add amazing feature'`)
122+
4. 📤 Push to the branch (`git push origin feature/amazing-feature`)
123+
5. 🎉 Open a Pull Request
124+
125+
---
93126

94-
## Author
127+
## 📄 License
128+
129+
This project is licensed under the **MIT License** — see the [LICENSE](LICENSE) file for details.
130+
131+
---
132+
133+
## 👨‍💻 Author
95134

96135
**Calvin A. Allen**
97-
- Website: [codingwithcalvin.net](https://codingwithcalvin.net)
98-
- GitHub: [@CodingWithCalvin](https://github.com/CodingWithCalvin)
136+
137+
[![Website](https://img.shields.io/badge/Website-codingwithcalvin.net-blue?style=flat&logo=google-chrome&logoColor=white)](https://codingwithcalvin.net)
138+
[![GitHub](https://img.shields.io/badge/GitHub-CodingWithCalvin-181717?style=flat&logo=github)](https://github.com/CodingWithCalvin)
99139

100140
---
101141

102-
*Git Ranger - Taming your Git history, one line at a time.*
142+
<div align="center">
143+
144+
### ⭐ If you find Git Ranger useful, please consider giving it a star! ⭐
145+
146+
*Made with ❤️ for the Visual Studio community from Coding With Calvin*
147+
148+
</div>

0 commit comments

Comments
 (0)