Skip to content

Commit 71643a2

Browse files
committed
docs(readme): modernize with emojis and improved formatting
- Add emojis throughout for visual appeal - Convert feature list to table format - Add tagline and more engaging copy - Add footer with attribution
1 parent ad1ef33 commit 71643a2

1 file changed

Lines changed: 42 additions & 31 deletions

File tree

README.md

Lines changed: 42 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,70 @@
1-
# Project Renamifier
1+
# 🔄 Project Renamifier
22

33
[![License](https://img.shields.io/github/license/CodingWithCalvin/VS-ProjectRenamifier?style=for-the-badge)](https://github.com/CodingWithCalvin/VS-ProjectRenamifier/blob/main/LICENSE)
44
[![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)
55
[![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)
66
[![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)
77

8-
A Visual Studio extension that allows you to safely and completely rename a project from within Visual Studio.
8+
> 🚀 **Rename projects the way it should have always worked!**
99
10-
## Features
10+
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! ✨
1111

12-
When you rename a project, this extension handles all of the following automatically:
12+
## ✨ Features
1313

14-
- **Project file rename** - Renames the `.csproj` file to match the new name
15-
- **Directory rename** - Renames the parent directory if it matches the old project name
16-
- **Project properties** - Updates `RootNamespace` and `AssemblyName` in the project file
17-
- **Namespace declarations** - Updates all `namespace` declarations in source files
18-
- **Using statements** - Updates `using`, `global using`, `using static`, and using aliases across the solution
19-
- **Fully qualified references** - Updates references like `OldName.MyClass` to `NewName.MyClass`
20-
- **Project references** - Updates `ProjectReference` paths in all projects that reference the renamed project
21-
- **Solution structure** - Preserves solution folder organization
14+
When you rename a project, this extension handles **all** of the following automatically:
2215

23-
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.
16+
| Feature | Description |
17+
|---------|-------------|
18+
| 📁 **Project file rename** | Renames the `.csproj` file to match the new name |
19+
| 📂 **Directory rename** | Renames the parent directory if it matches the old project name |
20+
| ⚙️ **Project properties** | Updates `RootNamespace` and `AssemblyName` in the project file |
21+
| 📝 **Namespace declarations** | Updates all `namespace` declarations in source files |
22+
| 📦 **Using statements** | Updates `using`, `global using`, `using static`, and using aliases across the solution |
23+
| 🔗 **Fully qualified references** | Updates references like `OldName.MyClass` to `NewName.MyClass` |
24+
| 🔧 **Project references** | Updates `ProjectReference` paths in all projects that reference the renamed project |
25+
| 🗂️ **Solution structure** | Preserves solution folder organization |
2426

25-
## Installation
27+
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. 🛡️
2628

27-
### Visual Studio Marketplace
29+
## 📥 Installation
2830

29-
Install directly from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-ProjectRenamifier).
31+
### Visual Studio Marketplace (Recommended)
32+
33+
Install directly from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-ProjectRenamifier) — just one click! 🎯
3034

3135
### Manual Installation
3236

33-
1. Download the `.vsix` file from the [Releases](https://github.com/CodingWithCalvin/VS-ProjectRenamifier/releases) page
34-
2. Double-click the downloaded file to install
37+
1. 📥 Download the `.vsix` file from the [Releases](https://github.com/CodingWithCalvin/VS-ProjectRenamifier/releases) page
38+
2. 🖱️ Double-click the downloaded file to install
3539

36-
## Usage
40+
## 🎮 Usage
3741

38-
1. Right-click on a project in Solution Explorer
39-
2. Select **Rename Project (Renamify)**
40-
3. Enter the new project name in the dialog
41-
4. Click **Rename** and watch the progress as each step completes
42+
1. 🖱️ Right-click on a project in Solution Explorer
43+
2. 📋 Select **Rename Project (Renamify)**
44+
3. ✏️ Enter the new project name in the dialog
45+
4. 🚀 Click **Rename** and watch the magic happen!
4246

43-
## Supported Versions
47+
## 💻 Supported Versions
4448

45-
- Visual Studio 2022 (17.x)
46-
- Visual Studio 2026 (18.x)
47-
- Architectures: x64 (amd64), ARM64
49+
| Visual Studio | Architectures |
50+
|---------------|---------------|
51+
| 🟢 Visual Studio 2022 (17.x) | x64 (amd64), ARM64 |
52+
| 🟢 Visual Studio 2026 (18.x) | x64 (amd64), ARM64 |
4853

49-
## Contributing
54+
## 🤝 Contributing
5055

51-
Contributions are welcome! Issues, PRs, etc.
56+
Contributions are welcome! Issues, PRs, feature requests — bring it on! 💪
5257

5358
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.
5459

55-
## Contributors
60+
## 👥 Contributors
5661

5762
<!-- readme: contributors -start -->
58-
[![CalvinAllen](https://avatars.githubusercontent.com/u/41448698?v=4&s=64)](https://github.com/CalvinAllen)
63+
[![CalvinAllen](https://avatars.githubusercontent.com/u/41448698?v=4&s=64)](https://github.com/CalvinAllen)
5964
<!-- readme: contributors -end -->
65+
66+
---
67+
68+
<p align="center">
69+
Made with ❤️ by <a href="https://github.com/CodingWithCalvin">Coding With Calvin</a>
70+
</p>

0 commit comments

Comments
 (0)