Skip to content

Commit e108462

Browse files
committed
📝 Documentation updates
1 parent ed10d4b commit e108462

File tree

2 files changed

+44
-3
lines changed

2 files changed

+44
-3
lines changed

LICENSE.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
Copyright (c) 2013 Michael Bleigh
2+
Copyright (c) 2023 Peter Boling of railsbling.com
23

34
MIT License
45

README.md

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,39 @@
11
# OmniAuth::JWT
22

3-
[![Build Status](https://travis-ci.org/mbleigh/omniauth-jwt.png)](https://travis-ci.org/mbleigh/omniauth-jwt)
3+
<div id="badges">
4+
5+
[![Current][🚎ciwfi]][🚎ciwf] [![Coverage][🖐cowfi]][🖐cowf] [![Style][🧮swfi]][🧮swf]
6+
7+
[![Legacy][🧮lwfi]][🧮lwf] [![Ancient][🧮awfi]][🧮awf]
8+
9+
---
10+
11+
[![Liberapay Patrons][⛳liberapay-img]][⛳liberapay]
12+
<span class="badge-buymeacoffee">
13+
[![Sponsor Me][🖇sponsor-img]][🖇sponsor]
14+
<a href="https://ko-fi.com/O5O86SNP4" target='_blank' title="Donate to my FLOSS or refugee efforts at ko-fi.com"><img src="https://img.shields.io/badge/buy%20me%20coffee-donate-yellow.svg" alt="Buy Me Coffee donation button" /></a>
15+
</span>
16+
<span class="badge-patreon">
17+
<a href="https://patreon.com/galtzo" title="Donate to my FLOSS or refugee efforts using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a>
18+
</span>
19+
20+
</div>
21+
22+
[🚎ciwf]: https://github.com/pboling/omniauth-jwt2/actions/workflows/ci.yml
23+
[🚎ciwfi]: https://github.com/pboling/omniauth-jwt2/actions/workflows/ci.yml/badge.svg
24+
[🖐cowf]: https://github.com/pboling/omniauth-jwt2/actions/workflows/coverage.yml
25+
[🖐cowfi]: https://github.com/pboling/omniauth-jwt2/actions/workflows/coverage.yml/badge.svg
26+
[🧮swf]: https://github.com/pboling/omniauth-jwt2/actions/workflows/style.yml
27+
[🧮swfi]: https://github.com/pboling/omniauth-jwt2/actions/workflows/style.yml/badge.svg
28+
[🧮lwf]: https://github.com/pboling/omniauth-jwt2/actions/workflows/legacy.yml
29+
[🧮lwfi]: https://github.com/pboling/omniauth-jwt2/actions/workflows/legacy.yml/badge.svg
30+
[🧮awf]: https://github.com/pboling/omniauth-jwt2/actions/workflows/ancient.yml
31+
[🧮awfi]: https://github.com/pboling/omniauth-jwt2/actions/workflows/ancient.yml/badge.svg
32+
33+
[⛳liberapay-img]: https://img.shields.io/liberapay/patrons/pboling.svg?logo=liberapay
34+
[⛳liberapay]: https://liberapay.com/pboling/donate
35+
[🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
36+
[🖇sponsor]: https://github.com/sponsors/pboling
437

538
[JSON Web Token](http://self-issued.info/docs/draft-ietf-oauth-json-web-token.html) (JWT) is a simple
639
way to send verified information between two parties online. This can be useful as a mechanism for
@@ -11,19 +44,26 @@ for example.
1144
OmniAuth::JWT provides a clean, simple wrapper on top of JWT so that you can easily implement this kind
1245
of SSO either between your own applications or allow third parties to delegate authentication.
1346

47+
## History
48+
49+
This library is a fork of the [original](https://github.com/mbleigh/omniauth-jwt)
50+
by Michael Bleigh which stopped development in 2013.
51+
It incorporates *all* of the fixes and features from the main forks by Aha, Discourse,
52+
and GitLab (which has been vendored inside GitLab, and isn't even in the fork network).
53+
1454
## Installation
1555

1656
Add this line to your application's Gemfile:
1757

18-
gem 'omniauth-jwt'
58+
gem 'omniauth-jwt2'
1959

2060
And then execute:
2161

2262
$ bundle
2363

2464
Or install it yourself as:
2565

26-
$ gem install omniauth-jwt
66+
$ gem install omniauth-jwt2
2767

2868
## Usage
2969

0 commit comments

Comments
 (0)