Skip to content

Commit 4e680fe

Browse files
authored
docs: update README with features and badges (#40)
1 parent d9edf76 commit 4e680fe

File tree

1 file changed

+41
-11
lines changed

1 file changed

+41
-11
lines changed

README.md

Lines changed: 41 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,53 @@
1-
# Project Renamifier (PRE-ALPHA STAGE)
1+
# Project Renamifier
22

3-
> This projecty is currently in its infancy and is not ready for primetime use. Please check back often for updates!
3+
[![License](https://img.shields.io/github/license/CodingWithCalvin/VS-ProjectRenamifier?style=for-the-badge)](https://github.com/CodingWithCalvin/VS-ProjectRenamifier/blob/main/LICENSE)
4+
[![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)
5+
[![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)
6+
[![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)
47

5-
A Visual Studio extension that allows you to safely - and COMPLETELY - rename a Project from within Visual Studio! This includes the filename, parent folder name (if it matches), and the namespace (includes changing the namespace in files that use it), plus fixing the path/filename of the project in the Solution file and all referencing projects.
8+
A Visual Studio extension that allows you to safely and completely rename a project from within Visual Studio.
69

7-
## License
10+
## Features
811

9-
[![License - MIT](https://img.shields.io/github/license/codingwithcalvin/VS-BreakpointNotifier?style=for-the-badge)](https://img.shields.io/github/license/codingwithcalvin/vs-BreakpointNotifier?style=for-the-badge)
12+
When you rename a project, this extension handles all of the following automatically:
1013

11-
## Build Status
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
1222

13-
TBD
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.
1424

15-
## Marketplace Status
25+
## Installation
1626

17-
TBD
27+
### Visual Studio Marketplace
1828

19-
## Contribute
29+
Install directly from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-ProjectRenamifier).
2030

21-
Contributions are welcome! Issues, PRs, etc.
31+
### Manual Installation
32+
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
35+
36+
## Usage
37+
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+
43+
## Supported Versions
44+
45+
- Visual Studio 2022 (17.x)
46+
- Visual Studio 2026 (18.x)
47+
- Architectures: x64 (amd64), ARM64
48+
49+
## Contributing
50+
51+
Contributions are welcome! Issues, PRs, etc.
2252

2353
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.

0 commit comments

Comments
 (0)