Skip to content
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.

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

Update README.md to recommend using OpenIddict for new applications #838

Merged
merged 1 commit into from
Mar 5, 2024

Conversation

kevinchalet
Copy link
Member

With most of the pain points addressed in previous OpenIddict releases (e.g WS-Federation claims or authentication schemes mapping) and a lot of services now being supported (78 at the time of writing), the OpenIddict client and its web providers are a good alternative to the packages we maintain here.

As such, I'd like to update the README to encourage users to adopt them for new applications (while still making clear the aspnet-contrib providers are still supported, of course).

@kevinchalet kevinchalet self-assigned this Mar 4, 2024
@@ -1,12 +1,42 @@

# AspNet.Security.OAuth.Providers

**AspNet.Security.OAuth.Providers** is a **collection of security middleware** that you can use in your **ASP.NET Core** application to support social authentication providers like **[GitHub](https://github.com/)**, **[Foursquare](https://foursquare.com/)** or **[Dropbox](https://www.dropbox.com/)**. It is directly inspired by **[Jerrie Pelser](https://github.com/jerriep)**'s initiative, **[Owin.Security.Providers](https://github.com/RockstarLabs/OwinOAuthProviders)**.
**AspNet.Security.OAuth.Providers** is a **collection of security middleware** that you can use in your **ASP.NET Core** application to support social authentication providers like **[GitHub](https://github.com/)**, **[Twitter/X](https://twitter.com/)** or **[Dropbox](https://www.dropbox.com/)**. It is directly inspired by **[Jerrie Pelser](https://github.com/jerriep)**'s initiative, **[Owin.Security.Providers](https://github.com/RockstarLabs/OwinOAuthProviders)**.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: I replaced Foursquare by Twitter because their new API no longer supports OAuth 2.0 (they now use API keys).

Copy link
Member

@martincostello martincostello left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My only comment is that it's quite big for a "tip" - on my screen setup at least, it's the almost the entire height of the screen.

Maybe just have a smaller tip at the top, that then links to a section further down with the additional details?

@kevinchalet
Copy link
Member Author

Maybe just have a smaller tip at the top, that then links to a section further down with the additional details?

Good idea! 👍🏻

@martincostello
Copy link
Member

Looks good 👍

@kevinchalet kevinchalet merged commit afe2a77 into aspnet-contrib:dev Mar 5, 2024
8 checks passed
@kevinchalet
Copy link
Member Author

Thanks!

@kevinchalet kevinchalet deleted the openiddict_readme branch March 5, 2024 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants