Skip to content

Commit 0c341d4

Browse files
committed
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
1 parent 87b5514 commit 0c341d4

1 file changed

Lines changed: 70 additions & 16 deletions

File tree

README.md

Lines changed: 70 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,97 @@
1-
# 🔴 Breakpoint Notifier
1+
<p align="center">
2+
<img src="https://raw.githubusercontent.com/CodingWithCalvin/VS-BreakpointNotifier/main/resources/logo.png" alt="Breakpoint Notifier Logo" width="128" height="128">
3+
</p>
24

3-
A Visual Studio extension that monitors debugging events and displays a notification when a breakpoint is hit. Perfect for when you're waiting for that breakpoint during a long-running process while catching up on YouTube videos! 🎬
5+
<h1 align="center">Breakpoint Notifier</h1>
46

5-
![Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/codingwithcalvin.VS-BreakpointNotifier?style=for-the-badge)
6-
![Marketplace Installations](https://img.shields.io/visual-studio-marketplace/i/codingwithcalvin.VS-BreakpointNotifier?style=for-the-badge)
7-
![License](https://img.shields.io/github/license/CodingWithCalvin/VS-BreakpointNotifier?style=for-the-badge)
8-
![Build Status](https://img.shields.io/github/actions/workflow/status/CodingWithCalvin/VS-BreakpointNotifier/build.yml?style=for-the-badge)
7+
<p align="center">
8+
<strong>🔴 Never miss a breakpoint again - get notified when debugging pauses!</strong>
9+
</p>
10+
11+
<p align="center">
12+
<a href="https://github.com/CodingWithCalvin/VS-BreakpointNotifier/blob/main/LICENSE">
13+
<img src="https://img.shields.io/github/license/CodingWithCalvin/VS-BreakpointNotifier?style=for-the-badge" alt="License">
14+
</a>
15+
<a href="https://github.com/CodingWithCalvin/VS-BreakpointNotifier/actions/workflows/build.yml">
16+
<img src="https://img.shields.io/github/actions/workflow/status/CodingWithCalvin/VS-BreakpointNotifier/build.yml?style=for-the-badge" alt="Build Status">
17+
</a>
18+
</p>
19+
20+
<p align="center">
21+
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-BreakpointNotifier">
22+
<img src="https://img.shields.io/visual-studio-marketplace/v/CodingWithCalvin.VS-BreakpointNotifier?style=for-the-badge" alt="Marketplace Version">
23+
</a>
24+
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-BreakpointNotifier">
25+
<img src="https://img.shields.io/visual-studio-marketplace/i/CodingWithCalvin.VS-BreakpointNotifier?style=for-the-badge" alt="Marketplace Installations">
26+
</a>
27+
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-BreakpointNotifier">
28+
<img src="https://img.shields.io/visual-studio-marketplace/d/CodingWithCalvin.VS-BreakpointNotifier?style=for-the-badge" alt="Marketplace Downloads">
29+
</a>
30+
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-BreakpointNotifier">
31+
<img src="https://img.shields.io/visual-studio-marketplace/r/CodingWithCalvin.VS-BreakpointNotifier?style=for-the-badge" alt="Marketplace Rating">
32+
</a>
33+
</p>
34+
35+
---
36+
37+
## 🤔 Why?
38+
39+
Waiting for that breakpoint to hit during a long-running process while catching up on YouTube videos? This extension monitors debugging events and displays a notification when a breakpoint is hit - so you never miss it! 🎬
940

1041
## ✨ Features
1142

1243
- 🎯 **Smart Detection** - Notifies on breakpoint hits
1344
- 💬 **Flexible Notifications** - Choose between Windows toast notifications, classic message box, or both!
1445
- ⚙️ **Configurable** - Customize your notification style via Tools > Options
1546
- 🖥️ **Multi-Architecture** - Supports both x64 and ARM64 systems
16-
- 🚀 **VS 2022 & 2026** - Compatible with Visual Studio 2022 and Visual Studio 2026
1747

18-
## 🔧 Configuration
48+
## 🛠️ Installation
49+
50+
### Visual Studio Marketplace
51+
52+
1. Open Visual Studio 2022 or 2026
53+
2. Go to **Extensions > Manage Extensions**
54+
3. Search for "Breakpoint Notifier"
55+
4. Click **Download** and restart Visual Studio
1956

20-
Configure your preferred notification style:
57+
### Manual Installation
2158

22-
1. Go to **Tools** > **Options**
23-
2. Navigate to **Breakpoint Notifier** > **General**
59+
Download the latest `.vsix` from the [Releases](https://github.com/CodingWithCalvin/VS-BreakpointNotifier/releases) page and double-click to install.
60+
61+
## 🚀 Usage
62+
63+
1. Install the extension and restart Visual Studio
64+
2. Go to **Tools > Options > Breakpoint Notifier > General**
2465
3. Select your **Notification Style**:
2566
- 🔔 **Toast** (default) - Non-intrusive Windows toast notification
2667
- 📦 **MessageBox** - Classic message box that steals focus
2768
- 🔔📦 **Both** - Get both notifications at once
69+
4. Start debugging and wait for that breakpoint! 🎉
70+
71+
## 🤝 Contributing
72+
73+
Contributions are welcome! Whether it's bug reports, feature requests, or pull requests - all feedback helps make this extension better.
2874

29-
## 🤝 Contribute
75+
### Development Setup
3076

31-
Contributions are welcome! Issues, PRs, etc. While it may seem this extension is "done", who knows what the future may hold for it? 🔮
77+
1. Clone the repository
78+
2. Open the solution in Visual Studio 2022 or 2026
79+
3. Ensure you have the "Visual Studio extension development" workload installed
80+
4. Press F5 to launch the experimental instance
3281

33-
For cloning and building this project yourself, make sure to install the [Extensibility Essentials 2022 extension](https://marketplace.visualstudio.com/items?itemName=MadsKristensen.ExtensibilityEssentials2022) for Visual Studio which enables some features used by this project.
82+
## 📄 License
83+
84+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
85+
86+
---
3487

3588
## 👥 Contributors
3689

3790
<!-- readme: contributors -start -->
38-
[![CalvinAllen](https://avatars.githubusercontent.com/u/41448698?v=4&s=64)](https://github.com/CalvinAllen) [![MarcolinoPT](https://avatars.githubusercontent.com/u/18648315?v=4&s=64)](https://github.com/MarcolinoPT)
3991
<!-- readme: contributors -end -->
4092

4193
---
4294

43-
Made with ❤️ by [Coding With Calvin](https://github.com/CodingWithCalvin)
95+
<p align="center">
96+
Made with ❤️ by <a href="https://github.com/CodingWithCalvin">Coding With Calvin</a>
97+
</p>

0 commit comments

Comments
 (0)