diff --git a/README.md b/README.md index aaf4665a..43cb3312 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,8 @@ OpenIddict natively supports **[Entity Framework Core](https://www.nuget.org/pac **[Entity Framework 6](https://www.nuget.org/packages/OpenIddict.EntityFramework)** and **[MongoDB](https://www.nuget.org/packages/OpenIddict.MongoDb)** out-of-the-box and custom stores can be implemented to support other providers. +-------------- + ## Getting started **Developers looking for a simple and turnkey solution are strongly encouraged to use [OrchardCore and its OpenID module](https://docs.orchardcore.net/en/dev/docs/reference/modules/OpenId/)**, @@ -26,6 +28,8 @@ which is based on OpenIddict, comes with sensible defaults and offers a built-in **Samples demonstrating how to use OpenIddict with the different OAuth 2.0/OpenID Connect flows** can be found in the [dedicated repository](https://github.com/openiddict/openiddict-samples). +-------------- + ## Compatibility matrix | Web framework version | .NET runtime version | OpenIddict 3.x | OpenIddict 4.x (preview) | @@ -56,6 +60,8 @@ can be found in the [dedicated repository](https://github.com/openiddict/openidd > - X.509 ECDSA signing certificates/keys: calling `AddSigningCertificate()` or `AddSigningKey()` > with an ECDSA certificate/key will always result in a `PlatformNotSupportedException` being thrown at runtime. +-------------- + ## Certification Unlike many other identity providers, **OpenIddict is not a turnkey solution but a framework that requires writing custom code** @@ -98,11 +104,15 @@ Instead, **developers are encouraged to execute the conformance tests against th - **[P41.OpenIddict.CouchDB](https://github.com/panoukos41/couchdb-openiddict)** by [Panos Athanasiou](https://github.com/panoukos41): CouchDB stores for OpenIddict - **[pixel-identity](https://github.com/Nfactor26/pixel-identity)** by [Nishant Singh](https://github.com/Nfactor26): Ready to host OpenID Connect service using OpenIddict and ASP.NET Identity with a Blazor-based UI for managing users, roles, applications and scopes with support for multiple databases. +-------------- + ## Security policy Security issues and bugs should be reported privately by emailing security@openiddict.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. +-------------- + ## Support If you need support, please make sure you [sponsor the project](https://github.com/sponsors/kevinchalet) before creating a GitHub ticket. @@ -111,6 +121,8 @@ If you're not a sponsor, you can post your questions on Gitter or StackOverflow: - **Gitter: [https://gitter.im/openiddict/openiddict-core](https://gitter.im/openiddict/openiddict-core)** - **StackOverflow: [https://stackoverflow.com/questions/tagged/openiddict](https://stackoverflow.com/questions/tagged/openiddict)** +-------------- + ## Nightly builds If you want to try out the latest features and bug fixes, there is a MyGet feed with nightly builds of OpenIddict. @@ -132,8 +144,20 @@ To reference the OpenIddict MyGet feed, **create a `NuGet.config` file** (at the **Special thanks to [our sponsors](https://github.com/sponsors/kevinchalet#sponsors) for their incredible support**: + + + + Volosoft logo + + + +
+
+ +-------------- + ## License This project is licensed under the **Apache License**. This means that you can use, modify and distribute it freely.