-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[net]build(nuget): add NuGet package readme and other info for Sails.…
…Net (#732)
- Loading branch information
1 parent
d59acc3
commit 737f3c8
Showing
2 changed files
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
Sails.Net | ||
========= | ||
|
||
A library providing and implementing low-level abstractions allowing to communicate with programs | ||
written using [Sails](https://github.com/gear-tech/sails?tab=readme-ov-file#sails-) framework. | ||
|
||
Although the library can be used independently, it offers a better experience when paired with | ||
[Sails.ClientGenerator](https://www.nuget.org/packages/Sails.ClientGenerator). | ||
|
||
### Usage | ||
|
||
Install the library, register `IRemotingProvider` implementation with `IServiceCollection`: | ||
```csharp | ||
var serviceCollection = new ServiceCollection(); | ||
serviceCollection.AddRemotingViaNodeClient( | ||
new NodeClientOptions | ||
{ | ||
GearNodeUri = new Uri("wss://testnet.vara.network"), | ||
}); | ||
``` | ||
Inject `IRemotingProvider` into your services and use it to communicate with Sails programs. | ||
Discover how it can be achieved via exploring [tests](https://github.com/gear-tech/sails/tree/master/net/tests/Sails.Remoting.Tests). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters