Skip to content

Updated README #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 24, 2024
Merged

Updated README #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 35 additions & 39 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# 🧰 Datasync Toolkit

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

Currently, the library supports:

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

The client platforms that have been tested include:

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

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
platforms any longer, but we have not removed the supporting code for them either.

Blazor and Unity can take advantage of the remote database connectivity but cannot use offline synchronization at the moment.

We support most databases that are supported by Entity Framework Core, along with an in-memory store and LiteDb. Support for additional
database types is easily added through our flexible repository pattern.

Other platforms may work, but have not been tested.

## 🙌 Getting Started

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

| Package | Version | Downloads |
|---------|---------|-----------|
| [CommunityToolkit.Datasync.Server] | ![Core Library Version][v1] | ![Core Library Downloads][d1] |
| [CommunityToolkit.Datasync.Server.Abstractions] | ![Abstractions Library Version][v2] | ![Abstractions Library Downloads][d2] |
| [CommunityToolkit.Datasync.Server.EFCore] | ![EFCore Library Version][v3] | ![EFCore Library Downloads][d3] |
| [CommunityToolkit.Datasync.Server.InMemory] | ![InMemory Library Version][v4] | ![InMemory Library Downloads][d4] |
| [CommunityToolkit.Datasync.Server.LiteDb] | ![LiteDb Library Version][v5] | ![LiteDb Library Downloads][d5] |
| [CommunityToolkit.Datasync.Server.NSwag] | ![NSwag Library Version][v6] | ![LiteDb Library Downloads][d6] |
| [CommunityToolkit.Datasync.Server.Swashbuckle] | ![Swashbuckle Library Version][v7] | ![LiteDb Library Downloads][d7] |
| [CommunityToolkit.Datasync.Client] | ![Client Library Version][vc1] | ![Client Library Downloads][dc1] |
| [CommunityToolkit.Client.SQLiteStore] | ![SQLiteStore Library Version][vc2] | ![SQLiteStore Library Downloads][dc2] |
| [CommunityToolkit.Datasync.Client] | ![Client Library Version][vc-core] | ![Client Library Downloads][dc-core] |
| [CommunityToolkit.Datasync.Server] | ![Core Library Version][vs-core] | ![Core Library Downloads][ds-core] |
| [CommunityToolkit.Datasync.Server.Abstractions] | ![Abstractions Library Version][vs-abstractions] | ![Abstractions Library Downloads][ds-abstractions] |
| [CommunityToolkit.Datasync.Server.Automapper] | ![Automapper Library Version][vs-automapper] | ![Automapper Library Downloads][ds-automapper] |
| [CommunityToolkit.Datasync.Server.EntityFrameworkCore] | ![EFCore Library Version][vs-efcore] | ![EFCore Library Downloads][ds-efcore] |
| [CommunityToolkit.Datasync.Server.InMemory] | ![InMemory Library Version][vs-inmemory] | ![InMemory Library Downloads][ds-inmemory] |
| [CommunityToolkit.Datasync.Server.LiteDb] | ![LiteDb Library Version][vs-litedb] | ![LiteDb Library Downloads][ds-litedb] |
| [CommunityToolkit.Datasync.Server.NSwag] | ![NSwag Library Version][vs-nswag] | ![NSwag Library Downloads][ds-nswag] |
| [CommunityToolkit.Datasync.Server.Swashbuckle] | ![Swashbuckle Library Version][vs-swashbuckle] | ![Swashbuckle Library Downloads][ds-swashbuckle] |

## 🌍 Roadmap

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

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


## 📄 Code of Conduct

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

<!-- Images -->
[v1]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server
[v2]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.Abstractions
[v3]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.EFCore
[v4]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.InMemory
[v5]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.LiteDb
[v6]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.NSwag
[v7]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.Swashbuckle
[vc1]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Client
[vc2]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Client.SQLiteStore

[d1]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server
[d2]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.Abstractions
[d3]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.EFCore
[d4]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.InMemory
[d5]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.LiteDb
[d6]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.NSwag
[d7]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.Swashbuckle
[dc1]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Client
[dc2]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Client.SQLiteStore
[vs-core]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server
[vs-abstractions]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.Abstractions
[vs-automapper]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.Automapper
[vs-efcore]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.EntityFrameworkCore
[vs-inmemory]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.InMemory
[vs-litedb]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.LiteDb
[vs-nswag]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.NSwag
[vs-swashbuckle]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Server.Swashbuckle
[vc-core]: https://badgen.net/nuget/v/CommunityToolkit.Datasync.Client

[ds-core]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server
[ds-abstractions]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.Abstractions
[ds-automapper]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.Automapper
[ds-efcore]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.EntityFrameworkCore
[ds-inmemory]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.InMemory
[ds-litedb]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.LiteDb
[ds-nswag]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.NSwag
[ds-swashbuckle]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Server.Swashbuckle
[dc-core]: https://badgen.net/nuget/dt/CommunityToolkit.Datasync.Client