Skip to content

Commit 5805d6e

Browse files
committed
Updated readmes to point to NuGet.
1 parent d024c28 commit 5805d6e

File tree

3 files changed

+32
-31
lines changed

3 files changed

+32
-31
lines changed

PowerSync/PowerSync.Common/PowerSync.Common.csproj

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
<PackageReleaseNotes>https://github.com/powersync-ja/powersync-dotnet/CHANGELOG.md</PackageReleaseNotes>
1818
<PackageTags>powersync local-first local-storage state-management offline sql db persistence sqlite sync </PackageTags>
1919
<PackageIcon>icon.png</PackageIcon>
20+
<NoWarn>NU5100</NoWarn>
2021
<PackageReadmeFile>README.md</PackageReadmeFile>
2122
</PropertyGroup>
2223

PowerSync/PowerSync.Common/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,20 @@
22

33
This package contains a .NET implementation of a PowerSync database connector and streaming sync bucket implementation.
44

5+
## ⚠️ Project Status & Release Note
6+
7+
This package is currently in an alpha state, intended strictly for testing. Expect breaking changes and instability as development continues.
8+
9+
Do not rely on this package for production use.
10+
11+
## Installation
12+
13+
This package is published on [NuGet](https://www.nuget.org/packages/PowerSync.Common).
14+
15+
```bash
16+
dotnet add package PowerSync.Common --prerelease
17+
```
18+
519
## Usage
620

721
### Simple Query

README.md

Lines changed: 17 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,10 @@ _[PowerSync](https://www.powersync.com) is a sync engine for building local-firs
88

99
`powersync-dotnet` is the monorepo for PowerSync .NET SDKs.
1010

11-
## ⚠️ Project Status & Release Note
12-
13-
This package is part of a monorepo that is not yet officially released or published. It is currently in a pre-alpha state, intended strictly for closed testing. Expect breaking changes and instability as development continues.
14-
15-
Do not rely on this package for production use.
16-
1711
## Monorepo Structure: Packages
1812

13+
Packages are published to [NuGet](https://www.nuget.org/profiles/PowerSync).
14+
1915
- [PowerSync/Common](./PowerSync/Common/README.md)
2016

2117
- Core package: .NET implementation of a PowerSync database connector and streaming sync bucket implementation. Packages meant for specific platforms will extend functionality of `Common`.
@@ -54,6 +50,18 @@ This PowerSync SDK currently targets the following .NET versions:
5450
<PackageReference Include="System.Net.Http" Version="4.3.4" />
5551
</ItemGroup>
5652
```
53+
54+
and create a `IsExternalInit.cs` file in your project with the following contents:
55+
56+
```cs
57+
using System.ComponentModel;
58+
59+
namespace System.Runtime.CompilerServices
60+
{
61+
[EditorBrowsable(EditorBrowsableState.Never)]
62+
internal class IsExternalInit { }
63+
}
64+
```
5765

5866
-------
5967

@@ -87,29 +95,7 @@ Run a specific test
8795
dotnet test -v n --framework net8.0 --filter "test-file-pattern"
8896
```
8997

90-
## Using the PowerSync.Common package in your project (temporary)
91-
A NuGet package will be available soon, until then you clone this repo and follow these steps:
92-
93-
Add the dependency to your project's .csproj:
94-
```.xml
95-
<ItemGroup>
96-
<ProjectReference Include="..\..\powersync-dotnet\PowerSync\Powersync.Common\PowerSync.Common.csproj" />
97-
</ItemGroup>
98-
```
99-
100-
Which assumes the following directory structure:
101-
```
102-
code/
103-
powersync-dotnet (X)
104-
├── PowerSync/PowerSync.Common
105-
│ ├── PowerSync.Common.csproj
106-
│ ├── Class1.cs
107-
│ └── Utils.cs
108-
└── root.sln
109-
110-
your-project
111-
├── demo
112-
│ ├── Program.csproj
113-
│ └── Program.cs
114-
├── root.sln
98+
## Using the PowerSync.Common package in your project
99+
```bash
100+
dotnet add package PowerSync.Common --prerelease
115101
```

0 commit comments

Comments
 (0)