Add client connection info for Azure SignalR - Fixes #3390 (#3463)

dotnet · Apr 8, 2024 · 6eb0480 · 6eb0480
1 parent 9a89cbf
commit 6eb0480
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/Aspire.Hosting.Azure.SignalR/README.md b/src/Aspire.Hosting.Azure.SignalR/README.md
@@ -27,9 +27,18 @@ var myService = builder.AddProject<Projects.MyService>()
                        .WithReference(signalR);
 ```
 
+The `WithReference` method configures a connection in the `MyService` project named `sr`. In the _Program.cs_ file of `MyService`, the Azure SignalR connection can be consumed using the client library [Microsoft.Azure.SignalR](https://www.nuget.org/packages/Microsoft.Azure.SignalR):
+
+```csharp
+builder.Services.AddSignalR()
+    .AddNamedAzureSignalR("sr");
+```
+
 ## Additional documentation
 
 * https://github.com/dotnet/aspire/tree/main/src/Components/README.md
+* https://learn.microsoft.com/dotnet/aspire/real-time/azure-signalr-scenario
+* https://learn.microsoft.com/azure/azure-signalr/signalr-overview
 
 ## Feedback & contributing