Skip to content

Commit af00695

Browse files
author
Adrian Hall
authored
Merge pull request #2 from adrianhall/issues/1/readme
Updated README
2 parents 56b47af + f316932 commit af00695

File tree

1 file changed

+35
-39
lines changed

1 file changed

+35
-39
lines changed

‎README.md‎

Lines changed: 35 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# 🧰 Datasync Toolkit
22

3-
The Datasync Toolkit (a part of the Community Toolkit) is a collection of libraries that implement a client-server system used for synchronizing data
3+
The Datasync Toolkit (a part of the Community Toolkit) is a collection of libraries that implement a client-server system used for synchronizing data
44
from the database table. The Datasync Toolkit is a member of the Community Toolkit organization and published under the dotnet Foundation.
55

66
Currently, the library supports:
77

8-
* Server: [ASP.NET 6 or later](https://learn.microsoft.com/aspnet/core/)
9-
* Client: .NET Standard 2.0 and .NET 6 or later
8+
* Server: [ASP.NET 8 or later](https://learn.microsoft.com/aspnet/core/)
9+
* Client: .NET 8 or later
1010

1111
The client platforms that have been tested include:
1212

@@ -16,14 +16,11 @@ The client platforms that have been tested include:
1616
* [Windows Presentation Framework (WPF)](https://learn.microsoft.com/dotnet/desktop/wpf/overview/?view=netdesktop-8.0)
1717
* [Windows UI Library (WinUI) 3](https://learn.microsoft.com/windows/apps/winui/winui3/)
1818

19-
In addition, prior versions of the library include Xamarin Forms, Xamarin Native (Android and iOS), and the Universal Windows Platform (UWP). We don't support those
20-
platforms any longer, but we have not removed the supporting code for them either.
21-
22-
Blazor and Unity can take advantage of the remote database connectivity but cannot use offline synchronization at the moment.
23-
2419
We support most databases that are supported by Entity Framework Core, along with an in-memory store and LiteDb. Support for additional
2520
database types is easily added through our flexible repository pattern.
2621

22+
Other platforms may work, but have not been tested.
23+
2724
## 🙌 Getting Started
2825

2926
Please take a look at the tutorials included in our [documentation][1].
@@ -49,15 +46,15 @@ The following NuGet packages have been published:
4946

5047
| Package | Version | Downloads |
5148
|---------|---------|-----------|
52-
| [CommunityToolkit.Datasync.Server] | ![Core Library Version][v1] | ![Core Library Downloads][d1] |
53-
| [CommunityToolkit.Datasync.Server.Abstractions] | ![Abstractions Library Version][v2] | ![Abstractions Library Downloads][d2] |
54-
| [CommunityToolkit.Datasync.Server.EFCore] | ![EFCore Library Version][v3] | ![EFCore Library Downloads][d3] |
55-
| [CommunityToolkit.Datasync.Server.InMemory] | ![InMemory Library Version][v4] | ![InMemory Library Downloads][d4] |
56-
| [CommunityToolkit.Datasync.Server.LiteDb] | ![LiteDb Library Version][v5] | ![LiteDb Library Downloads][d5] |
57-
| [CommunityToolkit.Datasync.Server.NSwag] | ![NSwag Library Version][v6] | ![LiteDb Library Downloads][d6] |
58-
| [CommunityToolkit.Datasync.Server.Swashbuckle] | ![Swashbuckle Library Version][v7] | ![LiteDb Library Downloads][d7] |
59-
| [CommunityToolkit.Datasync.Client] | ![Client Library Version][vc1] | ![Client Library Downloads][dc1] |
60-
| [CommunityToolkit.Client.SQLiteStore] | ![SQLiteStore Library Version][vc2] | ![SQLiteStore Library Downloads][dc2] |
49+
| [CommunityToolkit.Datasync.Client] | ![Client Library Version][vc-core] | ![Client Library Downloads][dc-core] |
50+
| [CommunityToolkit.Datasync.Server] | ![Core Library Version][vs-core] | ![Core Library Downloads][ds-core] |
51+
| [CommunityToolkit.Datasync.Server.Abstractions] | ![Abstractions Library Version][vs-abstractions] | ![Abstractions Library Downloads][ds-abstractions] |
52+
| [CommunityToolkit.Datasync.Server.Automapper] | ![Automapper Library Version][vs-automapper] | ![Automapper Library Downloads][ds-automapper] |
53+
| [CommunityToolkit.Datasync.Server.EntityFrameworkCore] | ![EFCore Library Version][vs-efcore] | ![EFCore Library Downloads][ds-efcore] |
54+
| [CommunityToolkit.Datasync.Server.InMemory] | ![InMemory Library Version][vs-inmemory] | ![InMemory Library Downloads][ds-inmemory] |
55+
| [CommunityToolkit.Datasync.Server.LiteDb] | ![LiteDb Library Version][vs-litedb] | ![LiteDb Library Downloads][ds-litedb] |
56+
| [CommunityToolkit.Datasync.Server.NSwag] | ![NSwag Library Version][vs-nswag] | ![NSwag Library Downloads][ds-nswag] |
57+
| [CommunityToolkit.Datasync.Server.Swashbuckle] | ![Swashbuckle Library Version][vs-swashbuckle] | ![Swashbuckle Library Downloads][ds-swashbuckle] |
6158

6259
## 🌍 Roadmap
6360

@@ -67,7 +64,6 @@ Read what we [plan for next iterations](https://github.com/CommunityToolkit/Data
6764

6865
We welcome community contributions. Check out our [contributing guide](CONTRIBUTING.md) to get started.
6966

70-
7167
## 📄 Code of Conduct
7268

7369
This project has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/) to clarify expected behavior in our community.
@@ -84,31 +80,31 @@ The Datasync Toolkit used to be known as Azure Mobile Apps. You can find the co
8480
<!-- Links -->
8581
[CommunityToolkit.Datasync.Server]: https://www.nuget.org/packages/CommunityToolkit.Datasync.Server
8682
[CommunityToolkit.Datasync.Server.Abstractions]: https://www.nuget.org/packages/CommunityToolkit.Datasync.Server.Abstractions
87-
[CommunityToolkit.Datasync.Server.EFCore]: https://www.nuget.org/packages/CommunityToolkit.Datasync.Server.EFCore
83+
[CommunityToolkit.Datasync.Server.Automapper]: https://www.nuget.org/packages/CommunityToolkit.Datasync.Server.Automapper
84+
[CommunityToolkit.Datasync.Server.EntityFrameworkCore]: https://www.nuget.org/packages/CommunityToolkit.Datasync.Server.EntityFrameworkCore
8885
[CommunityToolkit.Datasync.Server.InMemory]: https://www.nuget.org/packages/CommunityToolkit.Datasync.Server.InMemory
8986
[CommunityToolkit.Datasync.Server.LiteDb]: https://www.nuget.org/packages/CommunityToolkit.Datasync.Server.LiteDb
9087
[CommunityToolkit.Datasync.Server.NSwag]: https://www.nuget.org/packages/CommunityToolkit.Datasync.Server.NSwag
9188
[CommunityToolkit.Datasync.Server.Swashbuckle]: https://www.nuget.org/packages/CommunityToolkit.Datasync.Server.Swashbuckle
9289
[CommunityToolkit.Datasync.Client]: https://www.nuget.org/packages/CommunityToolkit.Datasync.Client
93-
[CommunityToolkit.Datasync.Client.SQLiteStore]: https://www.nuget.org/packages/CommunityToolkit.Datasync.Client.SQLiteStore
9490

9591
<!-- Images -->
96-
[v1]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server
97-
[v2]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.Abstractions
98-
[v3]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.EFCore
99-
[v4]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.InMemory
100-
[v5]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.LiteDb
101-
[v6]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.NSwag
102-
[v7]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.Swashbuckle
103-
[vc1]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Client
104-
[vc2]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Client.SQLiteStore
105-
106-
[d1]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server
107-
[d2]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.Abstractions
108-
[d3]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.EFCore
109-
[d4]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.InMemory
110-
[d5]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.LiteDb
111-
[d6]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.NSwag
112-
[d7]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.Swashbuckle
113-
[dc1]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Client
114-
[dc2]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Client.SQLiteStore
92+
[vs-core]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server
93+
[vs-abstractions]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.Abstractions
94+
[vs-automapper]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.Automapper
95+
[vs-efcore]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.EntityFrameworkCore
96+
[vs-inmemory]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.InMemory
97+
[vs-litedb]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.LiteDb
98+
[vs-nswag]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.NSwag
99+
[vs-swashbuckle]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.Swashbuckle
100+
[vc-core]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Client
101+
102+
[ds-core]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server
103+
[ds-abstractions]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.Abstractions
104+
[ds-automapper]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.Automapper
105+
[ds-efcore]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.EntityFrameworkCore
106+
[ds-inmemory]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.InMemory
107+
[ds-litedb]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.LiteDb
108+
[ds-nswag]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.NSwag
109+
[ds-swashbuckle]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.Swashbuckle
110+
[dc-core]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Client

0 commit comments

Comments
 (0)