Skip to content

Commit

Permalink
[net]build(nuget): add NuGet package readme and other info for Sails.…
Browse files Browse the repository at this point in the history
…Net (#732)
  • Loading branch information
DennisInSky authored Dec 12, 2024
1 parent d59acc3 commit 737f3c8
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
22 changes: 22 additions & 0 deletions net/src/Sails.Net/README.md
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).
8 changes: 8 additions & 0 deletions net/src/Sails.Net/Sails.Net.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,16 @@

<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<Description>Low-level abstractions for communicating with Sails programs</Description>
<PackageReadmeFile>README.md</PackageReadmeFile>
<PackageLicenseExpression>MIT OR Apache-2.0</PackageLicenseExpression>
<PackageTags>Sails, Vara, Gear, Substrate</PackageTags>
</PropertyGroup>

<ItemGroup>
<None Include="README.md" Pack="true" PackagePath="\" />
</ItemGroup>

<!-- Substrate.Gear.Api -->
<ItemGroup>
<PackageReference Include="Substrate.NET.API" />
Expand Down

0 comments on commit 737f3c8

Please sign in to comment.