diff --git a/docs/README.md b/docs/README.md index 6ba6f33..8f92840 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,15 +1,33 @@ # EntityFrameworkCore.Jet -This project is the Entity Framework Core provider for Jet (Microsoft Access mdb and accdb file format). +[![Build Status](https://bubibubi.visualstudio.com/EntityFrameworkCore.Jet/_apis/build/status/bubibubi.EntityFrameworkCore.Jet?branchName=master)](https://bubibubi.visualstudio.com/EntityFrameworkCore.Jet/_build/latest?definitionId=1&branchName=master) +[![NuGet](https://img.shields.io/nuget/v/EntityFrameworkCore.Jet.svg?style=flat-square&label=nuget)](https://www.nuget.org/packages/EntityFrameworkCore.Jet/) -This provider is mainly intended for desktop applications under .NET 4.6.1 (Console, WPF, WinForms and Services), but -may also work under ASP.NET 4.6 and ASP.NET Core 1.0 when using the .NET Framework runtime. It does **not** work under -the .NET Core runtime (netcore and netstandard). +`EntityFrameworkCore.Jet` is an Entity Framework Core provider for Jet (Microsoft Access database file formats `mdb` and `accdb`). -You can find the latest build on [NuGet](https://www.nuget.org/packages/EntityFrameworkCore.Jet/) - -## More documentation -More documentation can be found on project [Wiki](https://www.github.com/bubibubi/EntityFrameworkCore.Jet/wiki) +The provider is .NET Standard 2.0 compatible, so it can be used with .NET (Core) 2.0+ and .NET Framework 4.6.1+. + +The major version corresponds with the major version of EF Core (i.e. version `3.x` is compatible with EF Core `3.y`). + +It runs on Windows operating systems only and can be used with either ODBC or OLE DB together with their corresponding Access Database driver/provider. -## Questions -For question on how to use it please use stackoverflow, tags _access-ef-provider_ and _jet-ef-provider_. +## Stable Releases +All stable releases are available on [nuget.org](https://www.nuget.org/packages/EntityFrameworkCore.Jet/). + +## Daily Builds +To use the latest daily builds from our Azure DevOps feed, add a `NuGet.config` file to your solution root with the following content and enable _prereleases_: + +```xml + + + + + + + +``` + +## Further information +More information can be found on our [Wiki](https://www.github.com/bubibubi/EntityFrameworkCore.Jet/wiki). +## Questions +Any questions on how to use `EntityFrameworkCore.Jet` can be ask on [StackOverflow](https://stackoverflow.com/) using the `jet-ef-provider` and `entity-framework-core` tags.