Skip to content

Commit 30eaf1b

Browse files
CalvinAllenCalvinAllen
authored
docs(readme): standardize format to match template (#26)
- 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 753d15d commit 30eaf1b

1 file changed

Lines changed: 65 additions & 38 deletions

File tree

‎README.md‎

Lines changed: 65 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,98 @@
1-
<div align="center">
2-
3-
<img src="https://raw.githubusercontent.com/CodingWithCalvin/VS-SuperClean/main/resources/logo.png" alt="Super Clean Logo" width="256"/>
1+
<p align="center">
2+
<img src="https://raw.githubusercontent.com/CodingWithCalvin/VS-SuperClean/main/resources/logo.png" alt="Super Clean Logo" width="128" height="128">
3+
</p>
44

5-
---
5+
<h1 align="center">Super Clean</h1>
66

7-
[![License](https://img.shields.io/github/license/CodingWithCalvin/VS-SuperClean?style=for-the-badge)](https://github.com/CodingWithCalvin/VS-SuperClean/blob/main/LICENSE)
8-
[![Build](https://img.shields.io/github/actions/workflow/status/CodingWithCalvin/VS-SuperClean/build.yml?style=for-the-badge)](https://github.com/CodingWithCalvin/VS-SuperClean/actions/workflows/build.yml)
7+
<p align="center">
8+
<strong>Clean your solution the way it should have always worked!</strong>
9+
</p>
910

10-
[![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/CodingWithCalvin.VS-SuperClean?style=for-the-badge)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-SuperClean)
11-
[![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/CodingWithCalvin.VS-SuperClean?style=for-the-badge)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-SuperClean)
12-
[![Visual Studio Marketplace](https://img.shields.io/badge/VS%20Marketplace-Install-blue?style=for-the-badge&logo=visualstudio)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-SuperClean)
13-
[![Visual Studio Marketplace Rating](https://img.shields.io/visual-studio-marketplace/r/CodingWithCalvin.VS-SuperClean?style=for-the-badge)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-SuperClean)
11+
<p align="center">
12+
<a href="https://github.com/CodingWithCalvin/VS-SuperClean/blob/main/LICENSE">
13+
<img src="https://img.shields.io/github/license/CodingWithCalvin/VS-SuperClean?style=for-the-badge" alt="License">
14+
</a>
15+
<a href="https://github.com/CodingWithCalvin/VS-SuperClean/actions/workflows/build.yml">
16+
<img src="https://img.shields.io/github/actions/workflow/status/CodingWithCalvin/VS-SuperClean/build.yml?style=for-the-badge" alt="Build Status">
17+
</a>
18+
</p>
1419

15-
🧹 **Clean your solution the way it should have always worked!**
20+
<p align="center">
21+
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-SuperClean">
22+
<img src="https://img.shields.io/visual-studio-marketplace/v/CodingWithCalvin.VS-SuperClean?style=for-the-badge" alt="Marketplace Version">
23+
</a>
24+
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-SuperClean">
25+
<img src="https://img.shields.io/visual-studio-marketplace/i/CodingWithCalvin.VS-SuperClean?style=for-the-badge" alt="Marketplace Installations">
26+
</a>
27+
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-SuperClean">
28+
<img src="https://img.shields.io/visual-studio-marketplace/d/CodingWithCalvin.VS-SuperClean?style=for-the-badge" alt="Marketplace Downloads">
29+
</a>
30+
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-SuperClean">
31+
<img src="https://img.shields.io/visual-studio-marketplace/r/CodingWithCalvin.VS-SuperClean?style=for-the-badge" alt="Marketplace Rating">
32+
</a>
33+
</p>
1634

17-
Tired of lingering build artifacts causing mysterious issues? **Super Clean** nukes those `bin` and `obj` folders with a single click — no more hunting through folders manually! ✨
35+
---
1836

19-
</div>
37+
Tired of lingering build artifacts causing mysterious issues? **Super Clean** nukes those `bin` and `obj` folders with a single click - no more hunting through folders manually!
2038

21-
## ✨ Features
39+
## Features
2240

2341
| Feature | Description |
2442
|---------|-------------|
25-
| 🗂️ **Solution-level cleaning** | Right-click the solution to clean all projects at once |
26-
| 📁 **Project-level cleaning** | Right-click individual projects to clean just that project |
27-
| 🗑️ **Removes bin folder** | Deletes the entire `bin` directory and all its contents |
28-
| 📦 **Removes obj folder** | Deletes the entire `obj` directory and all its contents |
29-
| ⚡ **Fast and reliable** | Quick deletion without the overhead of MSBuild's Clean target |
43+
| **Solution-level cleaning** | Right-click the solution to clean all projects at once |
44+
| **Project-level cleaning** | Right-click individual projects to clean just that project |
45+
| **Removes bin folder** | Deletes the entire `bin` directory and all its contents |
46+
| **Removes obj folder** | Deletes the entire `obj` directory and all its contents |
47+
| **Fast and reliable** | Quick deletion without the overhead of MSBuild's Clean target |
3048

31-
## 📥 Installation
49+
## Installation
3250

33-
### Visual Studio Marketplace (Recommended)
51+
### Visual Studio Marketplace
3452

35-
[![Install from VS Marketplace](https://img.shields.io/badge/Install%20from-VS%20Marketplace-purple?style=for-the-badge&logo=visualstudio)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-SuperClean)
53+
1. Open Visual Studio 2022 or 2026
54+
2. Go to **Extensions > Manage Extensions**
55+
3. Search for "Super Clean"
56+
4. Click **Download** and restart Visual Studio
3657

3758
### Manual Installation
3859

39-
1. 📥 Download the `.vsix` file from the [Releases](https://github.com/CodingWithCalvin/VS-SuperClean/releases) page
40-
2. 🖱️ Double-click the downloaded file to install
60+
Download the latest `.vsix` from the [Releases](https://github.com/CodingWithCalvin/VS-SuperClean/releases) page and double-click to install.
4161

42-
## 🎮 Usage
62+
## Usage
4363

44-
1. 🖱️ Right-click on a **Solution** or **Project** in Solution Explorer
45-
2. 📋 Select **Super Clean**
46-
3. 🧹 Watch those `bin` and `obj` folders disappear!
64+
1. Right-click on a **Solution** or **Project** in Solution Explorer
65+
2. Select **Super Clean**
66+
3. Watch those `bin` and `obj` folders disappear!
4767

48-
## 💻 Supported Versions
68+
## Supported Versions
4969

5070
| Visual Studio | Architectures |
5171
|---------------|---------------|
52-
| 🟢 Visual Studio 2022 (17.x) | x64 (amd64), ARM64 |
53-
| 🟢 Visual Studio 2026 (18.x) | x64 (amd64), ARM64 |
72+
| Visual Studio 2022 (17.x) | x64 (amd64), ARM64 |
73+
| Visual Studio 2026 (18.x) | x64 (amd64), ARM64 |
5474

55-
## 📄 License
75+
## Contributing
5676

57-
This project is licensed under the [MIT License](LICENSE).
77+
Contributions are welcome! Whether it's bug reports, feature requests, or pull requests - all feedback helps make this extension better.
5878

59-
## 🤝 Contributing
79+
### Development Setup
6080

61-
Contributions are welcome! Issues, PRs, feature requests — bring it on! 💪
81+
1. Clone the repository
82+
2. Open the solution in Visual Studio 2022 or 2026
83+
3. Ensure you have the "Visual Studio extension development" workload installed
84+
4. Install the [Extensibility Essentials 2022](https://marketplace.visualstudio.com/items?itemName=MadsKristensen.ExtensibilityEssentials2022) extension
85+
5. Press F5 to launch the experimental instance
6286

63-
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.
87+
## License
88+
89+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
90+
91+
---
6492

65-
## 👥 Contributors
93+
## Contributors
6694

6795
<!-- readme: contributors -start -->
68-
[![CalvinAllen](https://avatars.githubusercontent.com/u/41448698?v=4&s=64)](https://github.com/CalvinAllen)
6996
<!-- readme: contributors -end -->
7097

7198
---

0 commit comments

Comments
 (0)