Skip to content

Commit d1158a4

Browse files
committed
📝 README.md organization
1 parent cc2c32d commit d1158a4

28 files changed

+123
-135
lines changed

README.md

Lines changed: 24 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,26 @@ If it seems like you are in the wrong place, you might try one of these:
8989

9090
### Compatibility
9191

92+
* Operating Systems: Linux, MacOS, Windows
93+
* MRI Ruby @ v2.3, v2.4, v2.5, v2.6, v2.7, v3.0, v3.1, v3.2, v3.3, v3.4, HEAD
94+
* NOTE: This gem will still install on ruby v2.2, but vanilla GitHub Actions no longer supports testing against it, so YMMV.
95+
* JRuby @ v9.2, v9.3, v9.4, v10.0, HEAD
96+
* TruffleRuby @ v23.1, v24.1, HEAD
97+
* gem `faraday` @ v0, v1, v2, HEAD ⏩️ [lostisland/faraday](https://github.com/lostisland/faraday)
98+
* gem `jwt` @ v1, v2, v3, HEAD ⏩️ [jwt/ruby-jwt](https://github.com/jwt/ruby-jwt)
99+
* gem `logger` @ v1.2, v1.5, v1.7, HEAD ⏩️ [ruby/logger](https://github.com/ruby/logger)
100+
* gem `multi_xml` @ v0.5, v0.6, v0.7, HEAD ⏩️ [sferik/multi_xml](https://github.com/sferik/multi_xml)
101+
* gem `rack` @ v1.2, v1.6, v2, v3, HEAD ⏩️ [rack/rack](https://github.com/rack/rack)
102+
* gem `snaky_hash` @ v2, HEAD ⏩️ [ruby-oauth/snaky_hash](https://gitlab.com/ruby-oauth/snaky_hash)
103+
* gem `version_gem` @ v1, HEAD ⏩️ [ruby-oauth/version_gem](https://gitlab.com/ruby-oauth/version_gem)
104+
105+
The last two were extracted from this gem. They are part of the `ruby-oauth` org,
106+
and are developed in tight collaboration with this gem.
107+
108+
Also, where reasonable, tested against the runtime dependencies of those dependencies:
109+
110+
* gem `hashie` @ v0, v1, v2, v3, v4, v5, HEAD ⏩️ [hashie/hashie](https://github.com/hashie/hashie)
111+
92112
#### Upgrading Runtime Gem Dependencies
93113

94114
This project sits underneath a large portion of the authorization systems on the internet.
@@ -110,26 +130,6 @@ covering the latest patch for each of the following minor versions:
110130
|------------------------------------------------|--------------------------------------------------------------------------------------|
111131
| 👟 Check it out! |[github.com/appraisal-rb/appraisal2](https://github.com/appraisal-rb/appraisal2)|
112132

113-
* Operating Systems: Linux, MacOS, Windows
114-
* MRI Ruby @ v2.3, v2.4, v2.5, v2.6, v2.7, v3.0, v3.1, v3.2, v3.3, v3.4, HEAD
115-
* NOTE: This gem will still install on ruby v2.2, but vanilla GitHub Actions no longer supports testing against it, so YMMV.
116-
* JRuby @ v9.2, v9.3, v9.4, v10.0, HEAD
117-
* TruffleRuby @ v23.1, v24.1, HEAD
118-
* gem `faraday` @ v0, v1, v2, HEAD ⏩️ [lostisland/faraday](https://github.com/lostisland/faraday)
119-
* gem `jwt` @ v1, v2, v3, HEAD ⏩️ [jwt/ruby-jwt](https://github.com/jwt/ruby-jwt)
120-
* gem `logger` @ v1.2, v1.5, v1.7, HEAD ⏩️ [ruby/logger](https://github.com/ruby/logger)
121-
* gem `multi_xml` @ v0.5, v0.6, v0.7, HEAD ⏩️ [sferik/multi_xml](https://github.com/sferik/multi_xml)
122-
* gem `rack` @ v1.2, v1.6, v2, v3, HEAD ⏩️ [rack/rack](https://github.com/rack/rack)
123-
* gem `snaky_hash` @ v2, HEAD ⏩️ [ruby-oauth/snaky_hash](https://gitlab.com/ruby-oauth/snaky_hash)
124-
* gem `version_gem` @ v1, HEAD ⏩️ [ruby-oauth/version_gem](https://gitlab.com/ruby-oauth/version_gem)
125-
126-
The last two were extracted from this gem. They are part of the `ruby-oauth` org,
127-
and are developed in tight collaboration with this gem.
128-
129-
Also, where reasonable, tested against the runtime dependencies of those dependencies:
130-
131-
* gem `hashie` @ v0, v1, v2, v3, v4, v5, HEAD ⏩️ [hashie/hashie](https://github.com/hashie/hashie)
132-
133133
#### You should upgrade this gem with confidence\*.
134134

135135
- This gem follows a _strict & correct_ (according to the maintainer of SemVer; [more info][sv-pub-api]) interpretation of SemVer.
@@ -371,13 +371,6 @@ NOTE: Be prepared to track down certs for signed gems and add them the same way
371371

372372
</details>
373373

374-
## Security contact information
375-
376-
To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).
377-
Tidelift will coordinate the fix and disclosure.
378-
379-
For more see [SECURITY.md][🔐security].
380-
381374
## What is new for v2.0?
382375

383376
- Works with Ruby versions >= 2.2
@@ -1002,7 +995,10 @@ I’m developing a new library, [floss_funding][🖇floss-funding-gem], designed
1002995

1003996
## 🔐 Security
1004997

1005-
See [SECURITY.md][🔐security].
998+
To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).
999+
Tidelift will coordinate the fix and disclosure.
1000+
1001+
For more see [SECURITY.md][🔐security].
10061002

10071003
## 🤝 Contributing
10081004

docs/OAuth2.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,7 @@ <h3 class="signature first" id="configure-class_method">
415415
</div>
416416

417417
<div id="footer">
418-
Generated on Sat Aug 30 18:32:34 2025 by
418+
Generated on Sat Aug 30 20:09:59 2025 by
419419
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
420420
0.9.37 (ruby-3.4.5).
421421
</div>

docs/OAuth2/AccessToken.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3069,7 +3069,7 @@ <h3 class="signature " id="to_hash-instance_method">
30693069
</div>
30703070

30713071
<div id="footer">
3072-
Generated on Sat Aug 30 18:32:34 2025 by
3072+
Generated on Sat Aug 30 20:09:59 2025 by
30733073
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
30743074
0.9.37 (ruby-3.4.5).
30753075
</div>

docs/OAuth2/Authenticator.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -883,7 +883,7 @@ <h3 class="signature first" id="apply-instance_method">
883883
</div>
884884

885885
<div id="footer">
886-
Generated on Sat Aug 30 18:32:34 2025 by
886+
Generated on Sat Aug 30 20:09:59 2025 by
887887
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
888888
0.9.37 (ruby-3.4.5).
889889
</div>

docs/OAuth2/Client.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2651,7 +2651,7 @@ <h3 class="signature " id="token_url-instance_method">
26512651
</div>
26522652

26532653
<div id="footer">
2654-
Generated on Sat Aug 30 18:32:34 2025 by
2654+
Generated on Sat Aug 30 20:09:59 2025 by
26552655
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
26562656
0.9.37 (ruby-3.4.5).
26572657
</div>

docs/OAuth2/Error.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -772,7 +772,7 @@ <h3 class="signature " id="response-instance_method">
772772
</div>
773773

774774
<div id="footer">
775-
Generated on Sat Aug 30 18:32:34 2025 by
775+
Generated on Sat Aug 30 20:09:59 2025 by
776776
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
777777
0.9.37 (ruby-3.4.5).
778778
</div>

docs/OAuth2/FilteredAttributes.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ <h3 class="signature first" id="inspect-instance_method">
335335
</div>
336336

337337
<div id="footer">
338-
Generated on Sat Aug 30 18:32:34 2025 by
338+
Generated on Sat Aug 30 20:09:59 2025 by
339339
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
340340
0.9.37 (ruby-3.4.5).
341341
</div>

docs/OAuth2/FilteredAttributes/ClassMethods.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ <h3 class="signature " id="filtered_attributes-instance_method">
280280
</div>
281281

282282
<div id="footer">
283-
Generated on Sat Aug 30 18:32:34 2025 by
283+
Generated on Sat Aug 30 20:09:59 2025 by
284284
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
285285
0.9.37 (ruby-3.4.5).
286286
</div>

docs/OAuth2/Response.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1619,7 +1619,7 @@ <h3 class="signature " id="status-instance_method">
16191619
</div>
16201620

16211621
<div id="footer">
1622-
Generated on Sat Aug 30 18:32:34 2025 by
1622+
Generated on Sat Aug 30 20:09:59 2025 by
16231623
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
16241624
0.9.37 (ruby-3.4.5).
16251625
</div>

docs/OAuth2/Strategy.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ <h2>Defined Under Namespace</h2>
107107
</div>
108108

109109
<div id="footer">
110-
Generated on Sat Aug 30 18:32:34 2025 by
110+
Generated on Sat Aug 30 20:09:59 2025 by
111111
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
112112
0.9.37 (ruby-3.4.5).
113113
</div>

0 commit comments

Comments
 (0)