From 7a6b5a66772e94af160c2678a06c9d582593cc0e Mon Sep 17 00:00:00 2001 From: Helen T <35390871+helenktsai@users.noreply.github.com> Date: Mon, 18 Dec 2023 10:26:46 -0800 Subject: [PATCH] ReadMe Review (#521) --- README.md | 17 +++++------------ 1 file changed, 5 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 9626012a..65ea2c3b 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,15 @@ # NServiceBus.Callbacks -This library provides extensions for NServiceBus which allow to define a callback on send operations. Callbacks can be used to map a response message to a stateful resource (e.g. a HTTP Request) without the need to use a message handler. +NServiceBus.Callbacks is an extension for NServiceBus to support defining callbacks on send operations. Callbacks can be used to map a response message to a stateful resource (e.g. an HTTP Request) without needing to use a message handler. +It is part of the [Particular Service Platform](https://particular.net/service-platform), which includes [NServiceBus](https://particular.net/nservicebus) and tools to build, monitor, and debug distributed systems. -### Getting started +See the [Client-side callbacks documentation](https://docs.particular.net/nservicebus/messaging/callbacks) for more details on how to use it. -To get started, install the package via NuGet: - -``` -Install-Package NServiceBus.Callbacks -``` - -### Testing callbacks +## Running tests locally To test callbacks, install the testing package via NuGet: ``` Install-Package NServiceBus.Callbacks.Testing -``` - -For more information please read our documentation about [Handling Responses on the Client Side](http://docs.particular.net/nservicebus/messaging/handling-responses-on-the-client-side) and the [Callbacks sample project](http://docs.particular.net/samples/callbacks/). +```