This is an automated email from the ASF dual-hosted git repository. aaronai pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/rocketmq-clients.git
commit 1d85ba07c466010679da47640cd11b9fa8163776 Author: Aaron Ai <[email protected]> AuthorDate: Thu Mar 2 10:44:46 2023 +0800 Rephrase README.md of .NET --- csharp/README.md | 38 ++++++++++++++++++-------------------- 1 file changed, 18 insertions(+), 20 deletions(-) diff --git a/csharp/README.md b/csharp/README.md index 63103420..774e1400 100644 --- a/csharp/README.md +++ b/csharp/README.md @@ -1,36 +1,34 @@ -# The C# Implementation of Apache RocketMQ Client +# The .NET Implementation of Apache RocketMQ Client -## Introduction +Here is the .NET implementation of the client for [Apache RocketMQ](https://rocketmq.apache.org/). -Here is the C# implementation of the client for [Apache RocketMQ](https://rocketmq.apache.org/). +## Supported .NET Versions -## Architecture - -Basically, this project would follow the same paradigm of [rocketmq-client-cpp v5.0.0](https://github.com/apache/rocketmq-client-cpp/tree/main). Namely, we would build the whole client following protocols described in [rocketmq-apis](https://github.com/apache/rocketmq-apis) on top of [gRPC-dotnet](https://github.com/grpc/grpc-dotnet), utilizing [Protocol buffers](https://developers.google.com/protocol-buffers) to serialize and deserialize data in transmission. +Due to the release of .NET 5 in 2020, which unified .NET Framework and .NET Core, and has gradually become the mainstream platform for .NET development, the RocketMQ client will support .NET 5 and later versions. -## How to build - -Layout of this project roughly follows [this guide](https://docs.microsoft.com/en-us/dotnet/core/tutorials/library-with-visual-studio-code?pivots=dotnet-5-0). The solution contains a class library, a unit test module and an example console module. +See more details about .NET 5 from [Introducing .NET 5](https://devblogs.microsoft.com/dotnet/introducing-net-5/). -1. Install dotnet tool chains following instructions [here](https://dotnet.microsoft.com/en-us/download); -2. Visual Studio Code with official C# plugin is used during development; +## Architecture -Assuming you are at the home of this repository, +The client would be developed using the protocols outlined in [rocketmq-apis](https://github.com/apache/rocketmq-apis) and built on [gRPC-dotnet](https://github.com/grpc/grpc-dotnet), leveraging Protocol Buffers for data serialization and deserialization during transmission. -### Build +## Quickstart ```sh -dotnet build +dotnet add package RocketMQ.Client ``` -### Run Unit Tests +You can obtain the latest version of `RocketMQ.Client` from [NuGet Gallery](https://www.nuget.org/packages/RocketMQ.Client). To assist with getting started quickly and working with various message types and clients, we offer additional code [here](./examples) here. -```sh -dotnet test -l "console;verbosity=detailed" -``` +## Build + +Layout of this project roughly follows [this guide](https://docs.microsoft.com/en-us/dotnet/core/tutorials/library-with-visual-studio-code?pivots=dotnet-5-0). The solution contains a class library, a unit test module and an example console module. -### Run Examples +Assuming you are at the home of this repository: ```sh -dotnet run -p examples +# build the project +dotnet build +# run unit tests +dotnet test -l "console;verbosity=detailed" ```
