📝 Add Alternatives section to README (closes #674)#730
Merged
pboling merged 5 commits intoJun 6, 2026
Conversation
Closes ruby-oauth#674 Replace the informal "if you are in the wrong place" bullet list under the Synopsis with a real "Alternatives" section: a comparison table of the prominent Ruby OAuth/OIDC libraries (omniauth-oauth2, openid_connect, rack-oauth2, doorkeeper, oauth 1.0a) describing each library's role and when you'd reach for it instead of this client gem. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #730 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 15 15
Lines 562 562
Branches 171 171
=========================================
Hits 562 562 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
pboling
approved these changes
Jun 6, 2026
pboling
left a comment
pboling
left a comment
Member
There was a problem hiding this comment.
This is awesome! Thanks :) I'll add the new oauth2-mcp to it after merging.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the project’s README to replace an informal “you might try one of these” bullet list with a structured “Alternatives” section that compares related OAuth/OIDC gems and directs readers to a better-fit library when oauth2 isn’t the right tool.
Changes:
- Replaced the prior bullet-list guidance with an
### Alternativessubsection containing a comparison table. - Added new reference-style link definitions for the listed libraries and an OpenID Connect link.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: |7eter l-|. l3oling <peter.boling@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
Addresses #674.
The top of the README had a "Synopsis" section with an informal bullet list ("If it seems like you are in the wrong place, you might try one of these…") that loosely approximated an alternatives list. #674 asked for this to become a real "Alternatives" section — a table of the alternatives and why you might use each.
This PR replaces that bullet list with an
### Alternativessubsection containing a comparison table.The table
oauth2)omniauth+omniauth-oauth2openid_connectrack-oauth2doorkeeperoauth(sibling gem)The selection follows the guidance in the #674 thread (doorkeeper as the major server library;
rack-oauth2/openid_connectas the prominent client-side options), and addsomniauth-oauth2and the OAuth 1.0a sibling gem for completeness. Maintainers/URLs/purpose were verified against each gem's RubyGems page.Notes for reviewer
oauth2-spec,sibling-gem,doorkeeper-gem) are preserved; new reference-style link definitions were added alongside them, plus an OpenID Connect spec link.[📜src-gh]reference definition.