📝 Document compatibility

Author: pboling

CONTRIBUTING.md

@@ -6,7 +6,7 @@ the [code of conduct][🤝conduct].
 
 To submit a patch, please fork the project, create a patch with tests, and send a pull request.
 
-Remember to [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] if you make changes.
+Remember to [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog].
 
 ## Help out!
 

README.md

@@ -21,7 +21,7 @@
 
 [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate to my FLOSS or refugee efforts at ko-fi.com][🖇kofi-img]][🖇kofi] [![Donate to my FLOSS or refugee efforts using Patreon][🖇patreon-img]][🖇patreon]
 
-Provides strategies for authenticating to providers using the OpenID v2 standard, which is deprecated, and very old. It is *not* for the modern OpenID Connect (OIDC) standard.  For OpenID Connect (OIDC) check out: [omniauth/omniauth_openid_connect](https://github.com/omniauth/omniauth_openid_connect)
+Provides strategies for authenticating to providers using the [OpenID v2 standard](https://openid.net/specs/openid-authentication-2_0.html), which was final in 2007, and predates OAuth, and OIDC. It is *not* for the modern OpenID Connect (OIDC) standard.  For OpenID Connect (OIDC) check out: [omniauth/omniauth_openid_connect](https://github.com/omniauth/omniauth_openid_connect).
 
 | Tokens to Remember    | [![Gem name][⛳️name-img]][⛳️gem-name] [![Gem namespace][⛳️namespace-img]][⛳️gem-namespace]                                                                                                                                                                                                                                                                                                                                                                          |
 |-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -79,11 +79,16 @@ NOTE: Be prepared to track down certs for signed gems and add them the same way
 
 ## 🔧 Compatibility
 
-...
+This gem is compatible with a wide range of Ruby Engines and OmniAuth versions, as of June 2025, version 2.0.2.
+
+* Tested in CI against:
+    * Ruby 2.4, 2.5, 2.6, 2.7, 3.0, 3.1, 3.2, 3.3, 3.4, ruby-head
+    * JRuby 9.2, 9.3, 9.4, 10.0, jruby-head
+    * omniauth 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 2.0, 2.1, HEAD
 
 ## 🔧 Basic Usage
 
-Use the strategy as a middleware in your application:
+Use the strategy as application middleware:
 
 ```ruby
 require "omniauth-openid"
@@ -230,7 +235,7 @@ See [LICENSE.txt][📄license] for the official [Copyright Notice][📄copyright
 ## 🤑 One more thing
 
 Having arrived at the bottom of the page, please endure a final supplication.
-The primary maintainer of this gem, Peter Boling, wants 
+The primary maintainer of this gem, Peter Boling, wants
 Ruby to be a great place for people to solve problems, big and small.
 Please consider supporting his efforts via the giant yellow link below,
 or one of smaller ones, depending on button size preference.

docs/_index.html

@@ -159,7 +159,7 @@ <h2>Namespace Listing A-Z</h2>
 </div>
 
       <div id="footer">
-  Generated on Sun Jun  8 12:13:16 2025 by
+  Generated on Sun Jun  8 13:25:41 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.4).
 </div>

docs/file.CONTRIBUTING.html

@@ -65,7 +65,7 @@
 
 <p>To submit a patch, please fork the project, create a patch with tests, and send a pull request.</p>
 
-<p>Remember to <a href="https://keepachangelog.com/en/1.0.0/"><img src="https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat" alt="Keep A Changelog"></a> if you make changes.</p>
+<p>Remember to <a href="https://keepachangelog.com/en/1.0.0/"><img src="https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat" alt="Keep A Changelog"></a>.</p>
 
 <h2 id="help-out">Help out!</h2>
 
@@ -192,7 +192,7 @@ <h3 id="to-release-a-new-version">To release a new version:</h3>
 </div></div>
 
       <div id="footer">
-  Generated on Sun Jun  8 12:13:16 2025 by
+  Generated on Sun Jun  8 13:25:41 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.4).
 </div>

docs/file.README.html

@@ -74,13 +74,13 @@
 
 <h1 id="-omniauthopenid">🫵 OmniAuth::OpenID</h1>
 
-<p><a href="https://rubygems.org/gems/omniauth-openid"><img src="https://img.shields.io/gem/v/omniauth-openid.svg" alt="Version"></a> <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-259D6C.svg" alt="License: MIT"></a> <a href="https://rubygems.org/gems/omniauth-openid"><img src="https://img.shields.io/gem/rd/omniauth-openid.svg" alt="Downloads Rank"></a> <a href="https://www.codetriage.com/omniauth/omniauth-openid"><img src="https://www.codetriage.com/omniauth/omniauth-openid/badges/users.svg" alt="Open Source Helpers"></a> <a href="https://depfu.com/github/omniauth/omniauth-openid?project_id=22381"><img src="https://badges.depfu.com/badges/6c9b45362951b872127f9e46d39bed76/count.svg" alt="Depfu"></a> <a href="https://codecov.io/gh/omniauth/omniauth-openid"><img src="https://codecov.io/gh/omniauth/omniauth-openid/branch/master/graph/badge.svg?token=E1fzzcuB8f" alt="CodeCov Test Coverage"></a> <a href="https://coveralls.io/github/omniauth/omniauth-openid?branch=master"><img src="https://coveralls.io/repos/github/omniauth/omniauth-openid/badge.svg?branch=master" alt="Coveralls Test Coverage"></a> <a href="https://github.com/omniauth/omniauth-openid/actions/workflows/heads.yml"><img src="https://github.com/omniauth/omniauth-openid/actions/workflows/heads.yml/badge.svg" alt="CI Heads"></a> <a href="https://github.com/omniauth/omniauth-openid/actions/workflows/current-runtime-heads.yml"><img src="https://github.com/omniauth/omniauth-openid/actions/workflows/current-runtime-heads.yml/badge.svg" alt="CI Runtime Dependencies @ HEAD"></a> <a href="https://github.com/omniauth/omniauth-openid/actions/workflows/current.yml"><img src="https://github.com/omniauth/omniauth-openid/actions/workflows/current.yml/badge.svg" alt="CI Current"></a> <a href="https://github.com/omniauth/omniauth-openid/actions/workflows/jruby.yml"><img src="https://github.com/omniauth/omniauth-openid/actions/workflows/jruby.yml/badge.svg" alt="CI JRuby"></a> <a href="https://github.com/omniauth/omniauth-openid/actions/workflows/supported.yml"><img src="https://github.com/omniauth/omniauth-openid/actions/workflows/supported.yml/badge.svg" alt="CI Supported"></a> <a href="https://github.com/omniauth/omniauth-openid/actions/workflows/legacy.yml"><img src="https://github.com/omniauth/omniauth-openid/actions/workflows/legacy.yml/badge.svg" alt="CI Legacy"></a> <a href="https://github.com/omniauth/omniauth-openid/actions/workflows/unsupported.yml"><img src="https://github.com/omniauth/omniauth-openid/actions/workflows/unsupported.yml/badge.svg" alt="CI Unsupported"></a> <a href="https://github.com/omniauth/omniauth-openid/actions/workflows/ancient.yml"><img src="https://github.com/omniauth/omniauth-openid/actions/workflows/ancient.yml/badge.svg" alt="CI Ancient"></a> <a href="https://github.com/omniauth/omniauth-openid/actions/workflows/coverage.yml"><img src="https://github.com/omniauth/omniauth-openid/actions/workflows/coverage.yml/badge.svg" alt="CI Test Coverage"></a> <a href="https://github.com/omniauth/omniauth-openid/actions/workflows/style.yml"><img src="https://github.com/omniauth/omniauth-openid/actions/workflows/style.yml/badge.svg" alt="CI Style"></a></p>
+<p><a href="https://rubygems.org/gems/omniauth-openid"><img src="https://img.shields.io/gem/v/omniauth-openid.svg" alt="Version"></a> <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-259D6C.svg" alt="License: MIT"></a> <a href="https://rubygems.org/gems/omniauth-openid"><img src="https://img.shields.io/gem/rd/omniauth-openid.svg" alt="Downloads Rank"></a> <a href="https://www.codetriage.com/omniauth/omniauth-openid"><img src="https://www.codetriage.com/omniauth/omniauth-openid/badges/users.svg" alt="Open Source Helpers"></a> <a href="https://depfu.com/github/omniauth/omniauth-openid?project_id=22381"><img src="https://badges.depfu.com/badges/6c9b45362951b872127f9e46d39bed76/count.svg" alt="Depfu"></a> <a href="https://coveralls.io/github/omniauth/omniauth-openid?branch=master"><img src="https://coveralls.io/repos/github/omniauth/omniauth-openid/badge.svg?branch=master" alt="Coveralls Test Coverage"></a> <a href="https://github.com/omniauth/omniauth-openid/actions/workflows/heads.yml"><img src="https://github.com/omniauth/omniauth-openid/actions/workflows/heads.yml/badge.svg" alt="CI Heads"></a> <a href="https://github.com/omniauth/omniauth-openid/actions/workflows/current-runtime-heads.yml"><img src="https://github.com/omniauth/omniauth-openid/actions/workflows/current-runtime-heads.yml/badge.svg" alt="CI Runtime Dependencies @ HEAD"></a> <a href="https://github.com/omniauth/omniauth-openid/actions/workflows/current.yml"><img src="https://github.com/omniauth/omniauth-openid/actions/workflows/current.yml/badge.svg" alt="CI Current"></a> <a href="https://github.com/omniauth/omniauth-openid/actions/workflows/jruby.yml"><img src="https://github.com/omniauth/omniauth-openid/actions/workflows/jruby.yml/badge.svg" alt="CI JRuby"></a> <a href="https://github.com/omniauth/omniauth-openid/actions/workflows/supported.yml"><img src="https://github.com/omniauth/omniauth-openid/actions/workflows/supported.yml/badge.svg" alt="CI Supported"></a> <a href="https://github.com/omniauth/omniauth-openid/actions/workflows/legacy.yml"><img src="https://github.com/omniauth/omniauth-openid/actions/workflows/legacy.yml/badge.svg" alt="CI Legacy"></a> <a href="https://github.com/omniauth/omniauth-openid/actions/workflows/unsupported.yml"><img src="https://github.com/omniauth/omniauth-openid/actions/workflows/unsupported.yml/badge.svg" alt="CI Unsupported"></a> <a href="https://github.com/omniauth/omniauth-openid/actions/workflows/ancient.yml"><img src="https://github.com/omniauth/omniauth-openid/actions/workflows/ancient.yml/badge.svg" alt="CI Ancient"></a> <a href="https://github.com/omniauth/omniauth-openid/actions/workflows/coverage.yml"><img src="https://github.com/omniauth/omniauth-openid/actions/workflows/coverage.yml/badge.svg" alt="CI Test Coverage"></a> <a href="https://github.com/omniauth/omniauth-openid/actions/workflows/style.yml"><img src="https://github.com/omniauth/omniauth-openid/actions/workflows/style.yml/badge.svg" alt="CI Style"></a></p>
 
 <hr>
 
 <p><a href="https://liberapay.com/pboling/donate"><img src="https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay" alt="Liberapay Goal Progress"></a> <a href="https://github.com/sponsors/pboling"><img src="https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&amp;logo=github" alt="Sponsor Me on Github"></a> <a href="https://www.buymeacoffee.com/pboling"><img src="https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-yellow.svg?style=flat" alt="Buy me a coffee"></a> <a href="https://polar.sh/pboling"><img src="https://img.shields.io/badge/polar-donate-yellow.svg" alt="Donate on Polar"></a> <a href="https://ko-fi.com/O5O86SNP4"><img src="https://img.shields.io/badge/a_more_different_coffee-%E2%9C%93-yellow.svg" alt="Donate to my FLOSS or refugee efforts at ko-fi.com"></a> <a href="https://patreon.com/galtzo"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Donate to my FLOSS or refugee efforts using Patreon"></a></p>
 
-<p>Provides strategies for authenticating to providers using the OpenID v2 standard, which is deprecated, and very old. It is <em>not</em> for the modern OpenID Connect (OIDC) standard.  For OpenID Connect (OIDC) check out: <a href="https://github.com/omniauth/omniauth_openid_connect">omniauth/omniauth_openid_connect</a></p>
+<p>Provides strategies for authenticating to providers using the <a href="https://openid.net/specs/openid-authentication-2_0.html">OpenID v2 standard</a>, which was final in 2007, and predates OAuth, and OIDC. It is <em>not</em> for the modern OpenID Connect (OIDC) standard.  For OpenID Connect (OIDC) check out: <a href="https://github.com/omniauth/omniauth_openid_connect">omniauth/omniauth_openid_connect</a>.</p>
 
 <table>
   <thead>
@@ -202,11 +202,21 @@ <h3 id="-secure-installation">🔒 Secure Installation</h3>
 
 <h2 id="-compatibility">🔧 Compatibility</h2>
 
-<p>…</p>
+<p>This gem is compatible with a wide range of Ruby Engines and OmniAuth versions, as of June 2025, version 2.0.2.</p>
+
+<ul>
+  <li>Tested in CI against:
+    <ul>
+      <li>Ruby 2.4, 2.5, 2.6, 2.7, 3.0, 3.1, 3.2, 3.3, 3.4, ruby-head</li>
+      <li>JRuby 9.2, 9.3, 9.4, 10.0, jruby-head</li>
+      <li>omniauth 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 2.0, 2.1, HEAD</li>
+    </ul>
+  </li>
+</ul>
 
 <h2 id="-basic-usage">🔧 Basic Usage</h2>
 
-<p>Use the strategy as a middleware in your application:</p>
+<p>Use the strategy as application middleware:</p>
 
 <pre class="code language-ruby"><code class="language-ruby">require &quot;omniauth-openid&quot;
 require &quot;openid/store/filesystem&quot;
@@ -264,7 +274,7 @@ <h3 id="-release-instructions">🚀 Release Instructions</h3>
 
 <h3 id="code-coverage">Code Coverage</h3>
 
-<p><a href="https://codecov.io/gh/omniauth/omniauth-openid"><img src="https://codecov.io/gh/omniauth/omniauth-openid/graphs/tree.svg?token=E1fzzcuB8f" alt="Coverage Graph"></a></p>
+<p><a href="https://coveralls.io/github/omniauth/omniauth-openid?branch=master"><img src="https://coveralls.io/repos/github/omniauth/omniauth-openid/badge.svg?branch=master" alt="Coveralls Test Coverage"></a></p>
 
 <h3 id="-code-of-conduct">🪇 Code of Conduct</h3>
 
@@ -349,25 +359,44 @@ <h3 id="-copyright">© Copyright</h3>
         </a>, and omniauth-openid contributors
     </li>
     <li>
-        2010-2011 Michael Bleigh, and Intridea, Inc.
+        Copyright (c) 2010-2011 Michael Bleigh, and Intridea, Inc.
     </li>
 </ul>
 
 <h2 id="-one-more-thing">🤑 One more thing</h2>
 
-<p>You made it to the bottom of the page,<br>
-so perhaps you’ll indulge me for another 20 seconds.<br>
-I maintain many dozens of gems, including this one,<br>
-because I want Ruby to be a great place for people to solve problems, big and small.<br>
-Please consider supporting my efforts via the giant yellow link below,<br>
-or one of the others at the head of this README.</p>
+<p>Having arrived at the bottom of the page, please endure a final supplication.<br>
+The primary maintainer of this gem, Peter Boling, wants<br>
+Ruby to be a great place for people to solve problems, big and small.<br>
+Please consider supporting his efforts via the giant yellow link below,<br>
+or one of smaller ones, depending on button size preference.</p>
 
 <p><a href="https://www.buymeacoffee.com/pboling"><img src="https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20latte&amp;emoji=&amp;slug=pboling&amp;button_colour=FFDD00&amp;font_colour=000000&amp;font_family=Cookie&amp;outline_colour=000000&amp;coffee_colour=ffffff" alt="Buy me a latte"></a></p>
 
+<p><a href="https://liberapay.com/pboling/donate"><img src="https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay" alt="Liberapay Goal Progress"></a> <a href="https://github.com/sponsors/pboling"><img src="https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&amp;logo=github" alt="Sponsor Me on Github"></a> <a href="https://polar.sh/pboling"><img src="https://img.shields.io/badge/polar-donate-yellow.svg" alt="Donate on Polar"></a> <a href="https://ko-fi.com/O5O86SNP4"><img src="https://img.shields.io/badge/a_more_different_coffee-%E2%9C%93-yellow.svg" alt="Donate to my FLOSS or refugee efforts at ko-fi.com"></a> <a href="https://patreon.com/galtzo"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Donate to my FLOSS or refugee efforts using Patreon"></a></p>
+
+<p>P.S. Use the gem =&gt; Discord for help</p>
+
+<p><a href="https://discord.gg/3qme4XHNKN"><img src="https://img.shields.io/discord/1373797679469170758?style=for-the-badge" alt="Live Chat on Discord"></a></p>
+
+<details>
+  <summary>
+    Disabled Badges
+  </summary>
+
+Badges for failing services.
+Bug reports filed.
+Once fixed, these should look much nicer.
+
+[![QLTY Maintainability][🔑qlty-mnti♻️]][🔑qlty-mnt]
+[![CodeCov Test Coverage][🔑codecovi♻️]][🔑codecov]
+[![Coverage Graph][🔑codecov-g♻️]][🔑codecov]
+
+</details>
 </div></div>
 
       <div id="footer">
-  Generated on Sun Jun  8 12:13:16 2025 by
+  Generated on Sun Jun  8 13:25:41 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.4).
 </div>