Mention SignalR Service explicitly in NPM README #12924
Conversation
anthonychu
requested review from
analogrelay,
BrennanConroy,
halter73 and
mikaelm12
as code owners
| @@ -1,4 +1,4 @@ | |||
| JavaScript and TypeScript clients for SignalR for ASP.NET Core | |||
| JavaScript and TypeScript clients for SignalR for ASP.NET Core and Azure SignalR Service | |||
There was a problem hiding this comment.
I feel like this is implied though. Probably no harm in adding it but is it necessary?
There was a problem hiding this comment.
As someone who didn't know about Azure SignalR Service, it was unclear to me 😅
There was a problem hiding this comment.
Yeah I found through a discussion with @bnb and others that if someone landed on the NPM page while searching for how to use SignalR with Functions, they hit a dead-end because the text suggests that this package only works with ASP.NET Core SignalR.
There was a problem hiding this comment.
I'm sort of with @mikaelm12 on this in that i feel like it is implied, but @bnb makes a good point as always so i'm also in line with @mikaelm12's flexibility. 👍
| @@ -14,6 +14,8 @@ yarn add @microsoft/signalr | |||
|
|
|||
| See the [SignalR Documentation](https://docs.microsoft.com/en-us/aspnet/core/signalr) at docs.microsoft.com for documentation on the latest release. [API Reference Documentation](https://docs.microsoft.com/javascript/api/%40aspnet/signalr/?view=signalr-js-latest) is also available on docs.microsoft.com. | |||
|
|
|||
| For documentation on using this client with Azure SignalR Service and Azure Functions, see the [SignalR Service serverless developer guide](https://docs.microsoft.com/azure/azure-signalr/signalr-concept-serverless-development-config). | |||
|
cc @bradygaster |
|
@anthonychu I'll merge this after the build I just kicked off passes. |
Summary of the changes (Less than 80 chars)