From cbabe8b21c1614d268b9cf089097c132368c3fd7 Mon Sep 17 00:00:00 2001 From: "Calvin A. Allen" Date: Fri, 30 Jan 2026 13:52:23 -0500 Subject: [PATCH] docs(readme): standardize format to match template - Centered header with logo, title, and tagline - Two rows of badges (License/Build, then Marketplace) - Consistent section structure with horizontal rules - Contributors section with markers - Centered footer with attribution --- README.md | 178 +++++++++++++++++++++++++++--------------------------- 1 file changed, 88 insertions(+), 90 deletions(-) diff --git a/README.md b/README.md index 6f4a6cb..0f54148 100644 --- a/README.md +++ b/README.md @@ -1,122 +1,132 @@

- Git Ranger Logo + Git Ranger Logo

Git Ranger

- Visual Studio 2022 - .NET Framework - License: MIT + A visually stunning Git management extension for Visual Studio with theme-adaptive vibrant colors

---- +

+ + License + + + Build Status + +

-A **visually stunning** Git management extension for Visual Studio 2022/2026, with theme-adaptive vibrant colors. 🎨✨ +

+ + Marketplace Version + + + Marketplace Installations + + + Marketplace Downloads + + + Marketplace Rating + +

--- -## 🚀 Features +## Features -### 🔍 Inline Blame Annotations +### Inline Blame Annotations -See who changed each line **directly in the editor** — author name, commit date, and message displayed right at the end of each line! +See who changed each line **directly in the editor** - author name, commit date, and message displayed right at the end of each line! -- 🎨 **Color-coded by author** — each contributor gets a unique vibrant color -- 🔥 **Heat map mode** — green = recent, red = old (optional) -- 👁️ **Configurable opacity** and display format -- 💬 **Hover for full commit details** +- **Color-coded by author** - each contributor gets a unique vibrant color +- **Heat map mode** - green = recent, red = old (optional) +- **Configurable opacity** and display format +- **Hover for full commit details** ![Inline Blame](https://raw.githubusercontent.com/CodingWithCalvin/VS-GitRanger/main/resources/blame-inline.png) -### 📊 Blame Gutter Margin +### Blame Gutter Margin A visual indicator in the editor margin showing commit history **at a glance**. -- 📈 Age bars showing relative commit age -- 🎯 Author color indicators -- 📋 Click to copy commit SHA -- 🔎 Hover for commit details +- Age bars showing relative commit age +- Author color indicators +- Click to copy commit SHA +- Hover for commit details ![Blame Gutter](https://raw.githubusercontent.com/CodingWithCalvin/VS-GitRanger/main/resources/blame-gutter.png) -### 📍 Status Bar Blame +### Status Bar Blame -See blame info for the **current line** right in the Visual Studio status bar — updates instantly as you navigate! +See blame info for the **current line** right in the Visual Studio status bar - updates instantly as you navigate! -- ⚡ **Real-time updates** — blame follows your cursor -- 🎛️ **Customizable format** — choose what to display with `{author}`, `{date}`, `{message}`, `{sha}` placeholders -- 📅 **Relative or absolute dates** — "2 days ago" or "1/21/2026" -- ✂️ **Auto-truncate** — configurable max length keeps your status bar tidy +- **Real-time updates** - blame follows your cursor +- **Customizable format** - choose what to display with `{author}`, `{date}`, `{message}`, `{sha}` placeholders +- **Relative or absolute dates** - "2 days ago" or "1/21/2026" +- **Auto-truncate** - configurable max length keeps your status bar tidy ![Status Bar Blame](https://raw.githubusercontent.com/CodingWithCalvin/VS-GitRanger/main/resources/blame-status-bar.png) -### 🔮 What's Next? +### What's Next? 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! ---- +## Installation -## 📦 Installation +### Visual Studio Marketplace -### From Visual Studio Marketplace +1. Open Visual Studio 2022 or 2026 +2. Go to **Extensions > Manage Extensions** +3. Search for "Git Ranger" +4. Click **Download** and restart Visual Studio -[![VS Marketplace](https://img.shields.io/badge/VS%20Marketplace-Git%20Ranger-purple?style=for-the-badge&logo=visualstudio&logoColor=white)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-GitRanger) +### Manual Installation -### From Source +Download the latest `.vsix` from the [Releases](https://github.com/CodingWithCalvin/VS-GitRanger/releases) page and double-click to install. -```bash -# 1. Clone the repository -git clone https://github.com/CodingWithCalvin/VS-GitRanger.git +## Configuration -# 2. Open in Visual Studio 2022 -# 3. Build the solution (F5 to debug) -# 4. VSIX will be created in the output directory -``` +Configure Git Ranger via **Tools > Options > Git Ranger** ---- - -## ⚙️ Configuration - -Configure Git Ranger via **Tools → Options → Git Ranger** - -### 🏷️ Blame Settings +### Blame Settings | Setting | Description | Default | |---------|-------------|---------| -| Enable Inline Blame | Show blame at end of lines | ✅ `true` | -| Enable Blame Gutter | Show blame in margin | ✅ `true` | -| Show Author Name | Display author in inline blame | ✅ `true` | -| Show Commit Date | Display date in inline blame | ✅ `true` | -| Show Commit Message | Display message in inline blame | ✅ `true` | +| Enable Inline Blame | Show blame at end of lines | `true` | +| Enable Blame Gutter | Show blame in margin | `true` | +| Show Author Name | Display author in inline blame | `true` | +| Show Commit Date | Display date in inline blame | `true` | +| Show Commit Message | Display message in inline blame | `true` | | Date Format | `relative` or custom format string | `relative` | -### 🎨 Color Settings +### Color Settings | Setting | Description | Default | |---------|-------------|---------| | Color Mode | `Author`, `Age`, or `None` | `Author` | | Max Age (days) | Maximum age for heat map | `365` | -### 🖥️ Display Settings +### Display Settings | Setting | Description | Default | |---------|-------------|---------| | Inline Blame Opacity | Transparency (0.0 - 1.0) | `0.7` | -| Compact Mode | Condensed display format | ❌ `false` | +| Compact Mode | Condensed display format | `false` | | Gutter Width | Width in pixels | `40` | -| Show Age Bars | Visual age indicators | ✅ `true` | +| Show Age Bars | Visual age indicators | `true` | -### 📍 Status Bar Settings +### Status Bar Settings | Setting | Description | Default | |---------|-------------|---------| -| Enable Status Bar Blame | Show blame in status bar | ✅ `true` | +| Enable Status Bar Blame | Show blame in status bar | `true` | | Format | Template with `{author}`, `{date}`, `{message}`, `{sha}` | `{author}, {date} • {message}` | -| Use Relative Dates | Show "2 days ago" vs absolute date | ✅ `true` | +| Use Relative Dates | Show "2 days ago" vs absolute date | `true` | | Max Length | Truncate long messages (0 = unlimited) | `100` | -### 🔧 Diagnostics +### Diagnostics | Setting | Description | Default | |---------|-------------|---------| @@ -124,56 +134,44 @@ Configure Git Ranger via **Tools → Options → Git Ranger** *Logs are written to the "Git Ranger" output pane in Visual Studio.* ---- - -## 📋 Requirements - -- 💻 Visual Studio 2022 (17.0) or later -- 🔧 .NET Framework 4.8 +## Requirements ---- +- Visual Studio 2022 (17.0) or later +- .NET Framework 4.8 -## 🛠️ Technology Stack +## Technology Stack | Component | Technology | |-----------|------------| -| 🔗 Git Integration | LibGit2Sharp | -| 🎨 UI Framework | WPF | -| 📊 Graph Rendering | SkiaSharp *(planned)* | -| 🔌 VS Integration | Community.VisualStudio.Toolkit | +| Git Integration | LibGit2Sharp | +| UI Framework | WPF | +| Graph Rendering | SkiaSharp *(planned)* | +| VS Integration | Community.VisualStudio.Toolkit | ---- - -## 🤝 Contributing +## Contributing -Contributions are welcome! Feel free to submit issues and pull requests. 💪 +Contributions are welcome! Whether it's bug reports, feature requests, or pull requests - all feedback helps make this extension better. -1. 🍴 Fork the repository -2. 🌿 Create a feature branch (`git checkout -b feature/amazing-feature`) -3. 💾 Commit your changes (`git commit -m 'feat: add amazing feature'`) -4. 📤 Push to the branch (`git push origin feature/amazing-feature`) -5. 🎉 Open a Pull Request +### Development Setup ---- +1. Clone the repository +2. Open the solution in Visual Studio 2022 or 2026 +3. Ensure you have the "Visual Studio extension development" workload installed +4. Press F5 to launch the experimental instance -## 📄 License +## License -This project is licensed under the **MIT License** — see the [LICENSE](LICENSE) file for details. +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. --- -## 👥 Contributors +## Contributors -[![CalvinAllen](https://avatars.githubusercontent.com/u/41448698?v=4&s=64)](https://github.com/CalvinAllen) --- -
- -### ⭐ If you find Git Ranger useful, please consider giving it a star! ⭐ - -*Made with ❤️ for the Visual Studio community from Coding With Calvin* - -
+

+ Made with ❤️ by Coding With Calvin +