Skip to content

Commit

Permalink
updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Erik Barale committed Nov 14, 2024
1 parent eb83cb6 commit 6b3628e
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 58 deletions.
48 changes: 0 additions & 48 deletions NetCore.Msmq.sln

This file was deleted.

20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# 🌐 NetCore.Msmq
# 🌐 Msmq.NetCore

**NetCore.Msmq** is an updated fork of **MSMQ.Messaging**, intended as a drop-in replacement for **System.Messaging** in .NET Core. Thanks to the original project, we've created this version with support for the latest .NET technologies. 🎉
**Msmq.NetCore** is an updated fork of **MSMQ.Messaging**, intended as a drop-in replacement for **System.Messaging** in .NET Core. Thanks to the original project, we've created this version with support for the latest .NET technologies. 🎉

> **Note**: NetCore.Msmq is compatible only with **.NET Standard 2.1** (Windows-only). For applications targeting .NET Framework, it is recommended to use **System.Messaging** instead.
> **Note**: Msmq.NetCore is compatible only with **.NET Standard 2.1** (Windows-only). For applications targeting .NET Framework, it is recommended to use **System.Messaging** instead.
## 🙏 Acknowledgments

Expand All @@ -12,32 +12,32 @@ A big thanks to **MSMQ.Messaging** for laying the foundation for this project. T

### Installation

You can install **NetCore.Msmq** directly from [NuGet](https://www.nuget.org/packages/MSMQ.Messaging/), or clone and build the project manually.
You can install **Msmq.NetCore** directly from [NuGet](https://www.nuget.org/packages/MSMQ.Messaging/), or clone and build the project manually.

### Build Instructions

1. Clone the repository:
```bash
git clone https://github.com/your-username/NetCore.Msmq.git
git clone https://github.com/your-username/Msmq.NetCore.git
```
2. Navigate to the source folder and build the project or open .sln file in Visual Studio:
```bash
cd NetCore.Msmq/Sources
cd Msmq.NetCore/Sources
dotnet build
```

## 📝 Important Notes

1. **NetCore.Msmq** relies on `mqrt.dll`, so it will only work on Windows.
1. **Msmq.NetCore** relies on `mqrt.dll`, so it will only work on Windows.
2. Queue configuration and MSMQ installation should work, but test coverage might be limited.
3. The API is compatible with the documentation for [System.Messaging](https://docs.microsoft.com/en-us/dotnet/api/system.messaging?view=netframework-4.8) in the classic .NET Framework.

## 🔄 Upgrading .NET Framework Projects

**NetCore.Msmq** is designed to be easy to use as a replacement for **System.Messaging** in .NET Core projects. To update legacy code, you only need to:
**Msmq.NetCore** is designed to be easy to use as a replacement for **System.Messaging** in .NET Core projects. To update legacy code, you only need to:

1. Change the reference from `System.Messaging` to `NetCore.Msmq`.
2. Update `using` statements from `System.Messaging` to `NetCore.Msmq`.
1. Change the reference from `System.Messaging` to `Msmq.NetCore`.
2. Update `using` statements from `System.Messaging` to `Msmq.NetCore`.

All other code should remain the same. 🌟

Expand Down

0 comments on commit 6b3628e

Please sign in to comment.