Go to file
David Fowler 24455da8fb Merge branch 'rel/1.0.0-alpha2' into dev 2017-09-18 20:46:14 -07:00
benchmarks/Microsoft.AspNetCore.SignalR.Microbenchmarks
build
client-ts Merge branch 'rel/1.0.0-alpha2' into dev 2017-09-18 10:48:53 -07:00
samples Moving versions to alpha2 2017-09-15 12:11:53 -07:00
specs Fix some markdown glitches. (#879) 2017-09-14 14:50:17 -07:00
src Merge branch 'rel/1.0.0-alpha2' into dev 2017-09-18 20:46:14 -07:00
test Merge branch 'rel/1.0.0-alpha2' into dev 2017-09-18 20:46:14 -07:00
.appveyor.yml
.gitattributes
.gitignore
.travis.yml
CONTRIBUTING.md
Directory.Build.props Moving versions to alpha2 2017-09-15 12:11:53 -07:00
Directory.Build.targets
LICENSE.txt
NuGet.config
NuGetPackageVerifier.json
README.md Update README.md 2017-09-15 08:16:35 -07:00
SignalR.sln
build.cmd
build.ps1
build.sh
version.xml Packages produced from dev branch should be alpha2 now 2017-09-15 13:44:33 -07:00

README.md

ASP.NET Core SignalR

AppVeyor: AppVeyor

Travis: Travis

ASP.NET Core SignalR is a new library for ASP.NET Core developers that makes it incredibly simple to add real-time web functionality to your applications. What is "real-time web" functionality? It's the ability to have your server-side code push content to the connected clients as it happens, in real-time.

You can watch an introductory presentation here - Introducing ASP.NET Core Sockets.

This project is part of ASP.NET Core. You can find samples, documentation and getting started instructions for ASP.NET Core at the Home repo.

Packages

You can install the latest released JavaScript client from npm with the following command:

npm install @aspnet/signalr-client

The CI build publishes the latest dev version of the JavaScript client to our dev npm registry as @aspnet/signalr-client. You can install the module as follows:

  • Create an .npmrc file with the following line: @aspnet:registry=https://dotnet.myget.org/f/aspnetcore-ci-dev/npm/
  • Run: npm install @aspnet/signalr-client

Alternatively, if you don't want to create the .npmrc file run the following commands:

npm install msgpack5
npm install @aspnet/signalr-client --registry https://dotnet.myget.org/f/aspnetcore-ci-dev/npm/

Building from source

To run a complete build on command line only, execute build.cmd or build.sh without arguments.

Before opening this project in Visual Studio or VS Code, execute build.cmd /t:Restore (Windows) or ./build.sh /t:Restore (Linux/macOS). This will execute only the part of the build script that downloads and initializes a few required build tools and packages.

See developer documentation for more details.