Skip to content

Commit 00f9dac

Browse files
committed
Fix the README links
1 parent 75d5f75 commit 00f9dac

File tree

6 files changed

+31
-10
lines changed

6 files changed

+31
-10
lines changed

NETCoreSync/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# NETCoreSync (Xamarin Version)
22

3-
| NETCoreSync |
3+
| Client + Server |
44
| :---: |
55
| [![Nuget](https://img.shields.io/nuget/v/NETCoreSync)](https://www.nuget.org/packages/NETCoreSync) |
66

77
This is the **Xamarin** version of NETCoreSync - a database synchronization framework where each client's local offline database (on each client's multiple devices) can be synchronized on-demand via network into a single centralized database hosted on a server. The NETCoreSync for Xamarin version is built using Microsoft .NET Standard 2.0, and needs to be implemented on both of your client-side and server-side projects.
88

9-
> To learn about NETCoreSync general requirements (characteristics such as database-agnostic, unique primary keys, soft-delete, etc.), visit the short-explanation on the root README [here](../README.md).
9+
> To learn about NETCoreSync general requirements (characteristics such as database-agnostic, unique primary keys, soft-delete, etc.), visit the short-explanation on the root README [here](../).
1010
11-
> If you're using [Flutter](https://flutter.dev) (which you should be :grin:), visit the Flutter version of NETCoreSync [here](../netcoresync_moor/README.md).
11+
> If you're using [Flutter](https://flutter.dev) (which you should be :grin:), visit the Flutter version of NETCoreSync [here](../netcoresync_moor).
1212
1313
## NuGet
1414

NETCoreSyncServer/NETCoreSyncServer.csproj

+15
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,21 @@
55
<Nullable>enable</Nullable>
66
</PropertyGroup>
77

8+
<PropertyGroup>
9+
<PackageId>NETCoreSyncServer</PackageId>
10+
<Authors>aldycool</Authors>
11+
<Company>chronustech.com</Company>
12+
<Description>The server-side .NET Core framework that hosts the synchronization data middleware for Flutter clients that uses the netcoresync_moor package.</Description>
13+
<PackageLicenseExpression>AGPL-3.0-only</PackageLicenseExpression>
14+
<PackageProjectUrl>https://github.com/aldycool/NETCoreSync/tree/master/NETCoreSyncServer</PackageProjectUrl>
15+
<RepositoryUrl>https://github.com/aldycool/NETCoreSync/tree/master/NETCoreSyncServer</RepositoryUrl>
16+
<PackageTags>database sync synchronization framework NETCoreApp NET5.0 Flutter</PackageTags>
17+
<PackageReleaseNotes>v1.0.0 Release Notes: Initial Release.</PackageReleaseNotes>
18+
<PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
19+
<Version>1.0.0</Version>
20+
<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
21+
</PropertyGroup>
22+
823
<ItemGroup>
924
<FrameworkReference Include="Microsoft.AspNetCore.App" />
1025
</ItemGroup>

NETCoreSyncServer/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
[![build](https://github.com/aldycool/NETCoreSync/actions/workflows/netcoresync_moor_build.yml/badge.svg?event=push)](https://github.com/aldycool/NETCoreSync/actions/workflows/netcoresync_moor_build.yml?query=event%3Apush) [![codecov](https://codecov.io/gh/aldycool/NETCoreSync/branch/master/graph/badge.svg?token=S2GTBOB7XB)](https://codecov.io/gh/aldycool/NETCoreSync)
44

5-
The server-side .NET Core framework that hosts the synchronization data middleware for Flutter clients that uses the `netcoresync_moor` package. This project is implemented in .NET 5.0 Middleware and uses WebSockets for its data communication. Read the `netcoresync_moor`'s [README](https://github.com/aldycool/NETCoreSync/blob/master/netcoresync_moor/README.md) for more details.
5+
The server-side .NET Core framework that hosts the synchronization data middleware for Flutter clients that uses the `netcoresync_moor` package. This project is implemented in .NET 5.0 Middleware and uses WebSockets for its data communication. Visit the [netcore_sync_moor repository](https://github.com/aldycool/NETCoreSync/blob/master/netcoresync_moor) for more details.

README.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,26 @@ This framework has two components that needs to be implemented in each of your c
88

99
[![build](https://github.com/aldycool/NETCoreSync/actions/workflows/netcoresync_moor_build.yml/badge.svg?event=push)](https://github.com/aldycool/NETCoreSync/actions/workflows/netcoresync_moor_build.yml?query=event%3Apush) [![codecov](https://codecov.io/gh/aldycool/NETCoreSync/branch/master/graph/badge.svg?token=S2GTBOB7XB)](https://codecov.io/gh/aldycool/NETCoreSync)
1010

11+
| Client | Client Generator | Server |
12+
| :---: | :---: | :---: |
13+
| [![netcoresync_moor version](https://img.shields.io/pub/v/netcoresync_moor.svg)](https://pub.dev/packages/netcoresync_moor) | [![netcoresync_moor_generator version](https://img.shields.io/pub/v/netcoresync_moor_generator.svg)](https://pub.dev/packages/netcoresync_moor_generator) | [![Nuget](https://img.shields.io/nuget/v/NETCoreSyncServer)](https://www.nuget.org/packages/NETCoreSyncServer) |
14+
1115
If the client is built using **[Flutter](https://flutter.dev/)**, use the Flutter version of NETCoreSync. This version provides `netcoresync_moor` package for the client side, and the `NETCorSyncServer` package for the server side. The client's `netcoresync_moor` package is built on top of Flutter's [Moor](https://github.com/simolus3/moor) library, and the server's `NETCoreSyncServer` package is built using Microsoft .NET 5.0 ASP .NET Core Middleware.
1216

1317
### Repository Folders
1418

1519
The repository folders are
1620
- [netcoresync_moor](netcoresync_moor): Client-side Flutter package
1721
- [netcoresync_moor_generator](netcoresync_moor_generator): Client-side Flutter code generator
18-
- [NETCoreSyncServer]: Server-side .NET 5.0 Middleware package
22+
- [NETCoreSyncServer](NETCoreSyncServer): Server-side .NET 5.0 Middleware package
1923
- [Samples/ServerTimeStamp/clientsample](Samples/ServerTimeStamp/clientsample): Client-side Flutter project example
2024
- [Samples/ServerTimeStamp/WebSample](Samples/ServerTimeStamp/WebSample): Server-side .NET 5.0 ASP Core project example
2125

2226
## Xamarin Version
2327

24-
| NETCoreSync |
28+
| Client + Server |
2529
| :---: |
26-
| [![Nuget](https://img.shields.io/nuget/v/NETCoreSync)](https://www.nuget.org/packages/NETCoreSync) |
30+
| [![NETCoreSync version](https://img.shields.io/nuget/v/NETCoreSync)](https://www.nuget.org/packages/NETCoreSync) |
2731

2832
If the client is built using **[Xamarin](https://dotnet.microsoft.com/apps/xamarin)**, use the Xamarin version of NETCoreSync. This version provides `NETCoreSync` package for both client and server side. The `NETCoreSync` package is built using Microsoft .NET Standard 2.0.
2933

@@ -60,6 +64,6 @@ The **Flutter** version is actually newer than the **Xamarin** version (the Xama
6064

6165
Moving forward, the Flutter version will be the primary development to have periodical updates and improvements, while the Xamarin version will remain as a backward-compatible solution only.
6266

63-
To read more about the **Flutter** version of NETCoreSync, visit the `netcoresync_moor` [here](netcoresync_moor/README.md).
67+
To read more about the **Flutter** version of NETCoreSync, visit the `netcoresync_moor` [here](netcoresync_moor).
6468

65-
To read more about the **Xamarin** version of NETCoreSync, visit the `NETCoreSync` [here](NETCoreSync/README.md).
69+
To read more about the **Xamarin** version of NETCoreSync, visit the `NETCoreSync` [here](NETCoreSync).

netcoresync_moor/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# netcoresync_moor
2+
13
[![build](https://github.com/aldycool/NETCoreSync/actions/workflows/netcoresync_moor_build.yml/badge.svg?event=push)](https://github.com/aldycool/NETCoreSync/actions/workflows/netcoresync_moor_build.yml?query=event%3Apush) [![codecov](https://codecov.io/gh/aldycool/NETCoreSync/branch/master/graph/badge.svg?token=S2GTBOB7XB)](https://codecov.io/gh/aldycool/NETCoreSync)
24

35
A database synchronization framework where each client's local offline database (on each client's multiple devices) can be synchronized on-demand via network into a single centralized database hosted on a server. Data which are stored locally within each device of a single client can all be synchronized after each device have successfully performed the synchronization operation. This is the Flutter version of the original [NETCoreSync](https://github.com/aldycool/NETCoreSync) framework.

netcoresync_moor_generator/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
[![build](https://github.com/aldycool/NETCoreSync/actions/workflows/netcoresync_moor_build.yml/badge.svg?event=push)](https://github.com/aldycool/NETCoreSync/actions/workflows/netcoresync_moor_build.yml?query=event%3Apush) [![codecov](https://codecov.io/gh/aldycool/NETCoreSync/branch/master/graph/badge.svg?token=S2GTBOB7XB)](https://codecov.io/gh/aldycool/NETCoreSync)
44

5-
The code generation tool (as `dev_dependencies`) for the `netcoresync_moor` package. Read the `netcoresync_moor`'s [README](https://github.com/aldycool/NETCoreSync/blob/master/netcoresync_moor/README.md) for more details.
5+
The code generation tool (as `dev_dependencies`) for the `netcoresync_moor` package. Visit the [netcore_sync_moor repository](https://github.com/aldycool/NETCoreSync/blob/master/netcoresync_moor) for more details.

0 commit comments

Comments
 (0)