Skip to content

Commit ea17324

Browse files
CalvinAllenCalvinAllen
authored
docs(readme): standardize format to match template (#70)
1 parent c076cb3 commit ea17324

1 file changed

Lines changed: 71 additions & 44 deletions

File tree

‎README.md‎

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

5-
---
5+
<h1 align="center">Project Renamifier</h1>
66

7-
[![License](https://img.shields.io/github/license/CodingWithCalvin/VS-ProjectRenamifier?style=for-the-badge)](https://github.com/CodingWithCalvin/VS-ProjectRenamifier/blob/main/LICENSE)
8-
[![Build](https://img.shields.io/github/actions/workflow/status/CodingWithCalvin/VS-ProjectRenamifier/build.yml?style=for-the-badge)](https://github.com/CodingWithCalvin/VS-ProjectRenamifier/actions/workflows/build.yml)
7+
<p align="center">
8+
<strong>Rename projects 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-ProjectRenamifier?style=for-the-badge)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-ProjectRenamifier)
11-
[![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/CodingWithCalvin.VS-ProjectRenamifier?style=for-the-badge)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-ProjectRenamifier)
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-ProjectRenamifier)
13-
[![Visual Studio Marketplace Rating](https://img.shields.io/visual-studio-marketplace/r/CodingWithCalvin.VS-ProjectRenamifier?style=for-the-badge)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-ProjectRenamifier)
11+
<p align="center">
12+
<a href="https://github.com/CodingWithCalvin/VS-ProjectRenamifier/blob/main/LICENSE">
13+
<img src="https://img.shields.io/github/license/CodingWithCalvin/VS-ProjectRenamifier?style=for-the-badge" alt="License">
14+
</a>
15+
<a href="https://github.com/CodingWithCalvin/VS-ProjectRenamifier/actions/workflows/build.yml">
16+
<img src="https://img.shields.io/github/actions/workflow/status/CodingWithCalvin/VS-ProjectRenamifier/build.yml?style=for-the-badge" alt="Build Status">
17+
</a>
18+
</p>
1419

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

17-
Tired of the tedious, error-prone process of renaming a project in Visual Studio? Say goodbye to manual find-and-replace across dozens of files! **Project Renamifier** handles everything automatically — one click, one dialog, done! ✨
35+
---
1836

19-
</div>
37+
Tired of the tedious, error-prone process of renaming a project in Visual Studio? Say goodbye to manual find-and-replace across dozens of files! **Project Renamifier** handles everything automatically - one click, one dialog, done!
2038

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

2341
When you rename a project, this extension handles **all** of the following automatically:
2442

2543
| Feature | Description |
2644
|---------|-------------|
27-
| 📁 **Project file rename** | Renames the `.csproj` file to match the new name |
28-
| 📂 **Directory rename** | Renames the parent directory if it matches the old project name |
29-
| ⚙️ **Project properties** | Updates `RootNamespace` and `AssemblyName` in the project file |
30-
| 📝 **Namespace declarations** | Updates all `namespace` declarations in source files |
31-
| 📦 **Using statements** | Updates `using`, `global using`, `using static`, and using aliases across the solution |
32-
| 🔗 **Fully qualified references** | Updates references like `OldName.MyClass` to `NewName.MyClass` |
33-
| 🔧 **Project references** | Updates `ProjectReference` paths in all projects that reference the renamed project |
34-
| 🗂️ **Solution structure** | Preserves solution folder organization |
45+
| **Project file rename** | Renames the `.csproj` file to match the new name |
46+
| **Directory rename** | Renames the parent directory if it matches the old project name |
47+
| **Project properties** | Updates `RootNamespace` and `AssemblyName` in the project file |
48+
| **Namespace declarations** | Updates all `namespace` declarations in source files |
49+
| **Using statements** | Updates `using`, `global using`, `using static`, and using aliases across the solution |
50+
| **Fully qualified references** | Updates references like `OldName.MyClass` to `NewName.MyClass` |
51+
| **Project references** | Updates `ProjectReference` paths in all projects that reference the renamed project |
52+
| **Solution structure** | Preserves solution folder organization |
3553

36-
The extension shows a progress dialog with step-by-step status as it performs the rename operation, and includes error handling with rollback support if something goes wrong. 🛡️
54+
The extension shows a progress dialog with step-by-step status as it performs the rename operation, and includes error handling with rollback support if something goes wrong.
3755

38-
## 📸 Screenshots
56+
## Screenshots
3957

4058
![Rename Dialog](https://raw.githubusercontent.com/CodingWithCalvin/VS-ProjectRenamifier/main/resources/rename-dialog.png)
4159

4260
![Progress Dialog](https://raw.githubusercontent.com/CodingWithCalvin/VS-ProjectRenamifier/main/resources/progress-dialog.png)
4361

44-
## 📥 Installation
62+
## Installation
4563

46-
### Visual Studio Marketplace (Recommended)
64+
### Visual Studio Marketplace
4765

48-
[![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-ProjectRenamifier)
66+
1. Open Visual Studio 2022 or 2026
67+
2. Go to **Extensions > Manage Extensions**
68+
3. Search for "Project Renamifier"
69+
4. Click **Download** and restart Visual Studio
4970

5071
### Manual Installation
5172

52-
1. 📥 Download the `.vsix` file from the [Releases](https://github.com/CodingWithCalvin/VS-ProjectRenamifier/releases) page
53-
2. 🖱️ Double-click the downloaded file to install
73+
Download the latest `.vsix` from the [Releases](https://github.com/CodingWithCalvin/VS-ProjectRenamifier/releases) page and double-click to install.
5474

55-
## 🎮 Usage
75+
## Usage
5676

57-
1. 🖱️ Right-click on a project in Solution Explorer
58-
2. 📋 Select **Renamify Project**
59-
3. ✏️ Enter the new project name in the dialog
60-
4. 🚀 Click **Rename** and watch the magic happen!
77+
1. Right-click on a project in Solution Explorer
78+
2. Select **Renamify Project**
79+
3. Enter the new project name in the dialog
80+
4. Click **Rename** and watch the magic happen!
6181

62-
## 💻 Supported Versions
82+
## Supported Versions
6383

6484
| Visual Studio | Architectures |
6585
|---------------|---------------|
66-
| 🟢 Visual Studio 2022 (17.x) | x64 (amd64), ARM64 |
67-
| 🟢 Visual Studio 2026 (18.x) | x64 (amd64), ARM64 |
86+
| Visual Studio 2022 (17.x) | x64 (amd64), ARM64 |
87+
| Visual Studio 2026 (18.x) | x64 (amd64), ARM64 |
6888

69-
## 📄 License
89+
## Contributing
7090

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

73-
## 🤝 Contributing
93+
### Development Setup
7494

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

77-
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.
101+
## License
102+
103+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
104+
105+
---
78106

79-
## 👥 Contributors
107+
## Contributors
80108

81109
<!-- readme: contributors -start -->
82-
[![CalvinAllen](https://avatars.githubusercontent.com/u/41448698?v=4&s=64)](https://github.com/CalvinAllen)
83110
<!-- readme: contributors -end -->
84111

85112
---

0 commit comments

Comments
 (0)