Skip to content

Commit e7d4d49

Browse files
committed
📝 Fix documentation in Yard (on RubyDoc.info)
1 parent 5c20801 commit e7d4d49

File tree

2 files changed

+26
-21
lines changed

2 files changed

+26
-21
lines changed

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1010
### Fixed
1111
### Removed
1212

13+
## 2.0.3 - 2024-09-25
14+
- COVERAGE: 97.72% -- 214/219 lines in 4 files
15+
- BRANCH COVERAGE: 86.00% -- 43/50 branches in 4 files
16+
- 39.13% documented
17+
### Added
18+
- Improved Documentation
19+
### Fixed
20+
- Documentation typos
21+
- Documentation in Yard (on RubyDoc.info)
22+
1323
## 2.0.2 - 2024-09-25
1424
- COVERAGE: 97.72% -- 214/219 lines in 4 files
1525
- BRANCH COVERAGE: 86.00% -- 43/50 branches in 4 files

README.md

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Rack::OpenID
22

3-
<div id="badges">
4-
53
[![Version](https://img.shields.io/gem/v/rack-openid2.svg)](https://rubygems.org/gems/rack-openid2)
64
[![Downloads Today](https://img.shields.io/gem/rd/rack-openid2.svg)](https://github.com/oauth-xx/rack-openid2)
75
[![CI Supported Build][🚎s-wfi]][🚎s-wf]
@@ -10,6 +8,14 @@
108
[![CI Coverage Build][🚎cov-wfi]][🚎cov-wf]
119
[![CI Heads Build][🚎hd-wfi]][🚎hd-wf]
1210

11+
-----
12+
13+
[![Liberapay Patrons][⛳liberapay-img]][⛳liberapay]
14+
[![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor]
15+
[![Polar Shield][🖇polar-img]][🖇polar]
16+
[![Donate to my FLOSS or refugee efforts at ko-fi.com][🖇kofi-img]][🖇kofi]
17+
[![Donate to my FLOSS or refugee efforts using Patreon][🖇patreon-img]][🖇patreon]
18+
1319
[🚎s-wf]: https://github.com/oauth-xx/rack-openid2/actions/workflows/supported.yml
1420
[🚎s-wfi]: https://github.com/oauth-xx/rack-openid2/actions/workflows/supported.yml/badge.svg
1521
[🚎us-wf]: https://github.com/oauth-xx/rack-openid2/actions/workflows/unsupported.yml
@@ -21,16 +27,6 @@
2127
[🚎hd-wf]: https://github.com/oauth-xx/rack-openid2/actions/workflows/heads.yml
2228
[🚎hd-wfi]: https://github.com/oauth-xx/rack-openid2/actions/workflows/heads.yml/badge.svg
2329

24-
-----
25-
26-
<div align="center">
27-
28-
[![Liberapay Patrons][⛳liberapay-img]][⛳liberapay]
29-
[![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor]
30-
[![Polar Shield][🖇polar-img]][🖇polar]
31-
[![Donate to my FLOSS or refugee efforts at ko-fi.com][🖇kofi-img]][🖇kofi]
32-
[![Donate to my FLOSS or refugee efforts using Patreon][🖇patreon-img]][🖇patreon]
33-
3430
[⛳liberapay-img]: https://img.shields.io/liberapay/patrons/pboling.svg?logo=liberapay
3531
[⛳liberapay]: https://liberapay.com/pboling/donate
3632
[🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
@@ -41,13 +37,8 @@
4137
[🖇kofi]: https://ko-fi.com/O5O86SNP4
4238
[🖇patreon-img]: https://img.shields.io/badge/patreon-donate-yellow.svg
4339
[🖇patreon]: https://patreon.com/galtzo
44-
45-
<span class="badge-buymealatte">
46-
<a href="https://www.buymeacoffee.com/pboling"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a latte&emoji=&slug=pboling&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff" /></a>
47-
</span>
48-
49-
</div>
50-
</div>
40+
[🖇buyme-img]: https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20latte&emoji=&slug=pboling&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff
41+
[🖇buyme]: https://www.buymeacoffee.com/pboling
5142

5243
Provides a more HTTPish API around the ruby-openid library.
5344

@@ -138,7 +129,7 @@ __END__
138129
|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
139130
| gem name | [ruby-openid2](https://rubygems.org/gems/rack-openid2) |
140131
| code triage | [![Open Source Helpers](https://www.codetriage.com/oauth-xx/rack-openid2/badges/users.svg)](https://www.codetriage.com/oauth-xx/rack-openid2) |
141-
| documentation | [on Github.com][homepage], [on Rdoc.info][documentation] |
132+
| documentation | [on Github.com][homepage], [on rubydoc.info][documentation] |
142133
| expert support | [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github) |
143134
| `...` 💖 | [![Liberapay Patrons][⛳liberapay-img]][⛳liberapay] [![Sponsor Me][🖇sponsor-img]][🖇sponsor] [![Follow Me on LinkedIn][🖇linkedin-img]][🖇linkedin] [![Find Me on WellFound:][✌️wellfound-img]][✌️wellfound] [![Find Me on CrunchBase][💲crunchbase-img]][💲crunchbase] [![My LinkTree][🌳linktree-img]][🌳linktree] [![Follow Me on Ruby.Social][🐘ruby-mast-img]][🐘ruby-mast] [![Tweet @ Peter][🐦tweet-img]][🐦tweet] [💻][coderme] [🌏][aboutme] |
144135

@@ -157,7 +148,7 @@ __END__
157148
[🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https%3A%2F%2Fruby.social&style=plastic&logo=mastodon&label=Ruby%20%40galtzo
158149
[🌳linktree]: https://linktr.ee/galtzo
159150
[🌳linktree-img]: https://img.shields.io/badge/galtzo-purple?style=plastic&logo=linktree
160-
[documentation]: http://rdoc.info/github/oauth-xx/rack-openid2/frames
151+
[documentation]: https://rubydoc.info/github/oauth-xx/rack-openid2
161152
[homepage]: https://github.com/oauth-xx/rack-openid2
162153

163154
<!-- Maintainer Contact Links -->
@@ -243,3 +234,7 @@ See [LICENSE.txt][📄license] for the official [Copyright Notice][📄copyright
243234
[📄license]: LICENSE.txt
244235
[📄license-ref]: https://opensource.org/licenses/MIT
245236
[📄license-img]: https://img.shields.io/badge/License-MIT-green.svg
237+
238+
You made it to the bottom of the page!
239+
240+
[![Buy me a latte][🖇buyme-img]][🖇buyme]

0 commit comments

Comments
 (0)