Skip to content

Commit

Permalink
chore: update readme, package.json, etc
Browse files Browse the repository at this point in the history
  • Loading branch information
panva committed Oct 14, 2021
1 parent dd2cf9e commit 6de3812
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 27 deletions.
20 changes: 4 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# jose

> Universal "JSON Web Almost Everything" - JWA, JWS, JWE, JWT, JWK with no dependencies using native crypto runtimes
> "JSON Web Almost Everything" - JWA, JWS, JWE, JWT, JWK, JWKS with no dependencies using runtime's native crypto in Node.js, Browser, Cloudflare Workers, Electron, and Deno.
## Implemented specs & features

Expand Down Expand Up @@ -73,28 +73,18 @@ If you or your business use `jose`, please consider becoming a [sponsor][support

| Version | Security Fixes 🔑 | Other Bug Fixes 🐞 | New Features ⭐ |
| ------- | --------- | -------- | -------- |
| [3.x.x](https://github.com/panva/jose) ||||
| [4.x.x](https://github.com/panva/jose) ||||
| [3.x.x](https://github.com/panva/jose/tree/v3.x) || ✅ until 2022-04-30 ||
| [2.x.x](https://github.com/panva/jose/tree/v2.x) || ✅ until 2022-04-30 ||
| [1.x.x](https://github.com/panva/jose/tree/v1.x) ||||

#### What is new in v3.x?

- Revised API
- No dependencies
- Browser, Cloudflare Workers, and Deno support (using [Web Cryptography API][webcrypto])
- Promise-based API

#### v2.x docs?

[Here.](https://github.com/panva/jose/blob/v2.x/docs/README.md)

#### Semver?

**Yes.** All module's public API is subject to [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html).

#### How is it different from [`jws`](https://github.com/brianloveswords/node-jws), [`jwa`](https://github.com/brianloveswords/node-jwa) or [`jsonwebtoken`](https://github.com/auth0/node-jsonwebtoken)?

- it supports the browser, Cloudflare Workers, and Deno runtimes
- it supports Browser, Cloudflare Workers, and Deno runtimes
- it supports encrypted JWTs (i.e. in JWE format)
- supports secp256k1, Ed25519, Ed448, X25519, and X448
- it supports JWK Key Format for all four key types (oct, RSA, EC and OKP)
Expand All @@ -111,8 +101,6 @@ polyfills and javascript implementation code in the form of
of the modules with dependencies that either aren't ever used or have native implementation available
in the runtime already, those are often times faster and more reliable.

- it has smaller module footprint as it does not bundle unnecessary polyfills
- it does not bundle [`node-forge`](https://github.com/digitalbazaar/forge) fallbacks when crypto runtime is unavailable
- supports secp256k1, Ed25519, Ed448, X25519, and X448

#### Uint8Array?!
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `jose` Modules API Documentation

> "JSON Web Almost Everything" - JWA, JWS, JWE, JWT, JWK with no dependencies using native crypto runtimes
> "JSON Web Almost Everything" - JWA, JWS, JWE, JWT, JWK, JWKS with no dependencies using runtime's native crypto.
## Support

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "jose",
"version": "3.20.3",
"description": "Universal 'JSON Web Almost Everything' - JWA, JWS, JWE, JWT, JWK with no dependencies",
"description": "'JSON Web Almost Everything' - JWA, JWS, JWE, JWT, JWK, JWKS with no dependencies using runtime's native crypto",
"keywords": [
"browser",
"cloudflare",
Expand Down
2 changes: 1 addition & 1 deletion tools/publish-browser.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ delete pkg.devDependencies;
delete pkg.scripts;
delete pkg.imports;

pkg.description = pkg.description.replace("Universal ", "(Browser Runtime) ");
pkg.description = `(Browser Runtime) ${pkg.description}`;

delete pkg.main;
delete pkg.exports["."].import;
Expand Down
5 changes: 1 addition & 4 deletions tools/publish-node-cjs.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,7 @@ delete pkg.devDependencies;
delete pkg.scripts;
delete pkg.imports;

pkg.description = pkg.description.replace(
"Universal ",
"(Node.JS CJS Runtime) "
);
pkg.description = `(Node.JS CJS Runtime) ${pkg.description}`;

delete pkg.browser;
delete pkg.exports["."].browser;
Expand Down
5 changes: 1 addition & 4 deletions tools/publish-node-esm.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,7 @@ delete pkg.devDependencies;
delete pkg.scripts;
delete pkg.imports;

pkg.description = pkg.description.replace(
"Universal ",
"(Node.JS ESM Runtime) "
);
pkg.description = `(Node.JS ESM Runtime) ${pkg.description}`;

delete pkg.browser;
delete pkg.exports["."].browser;
Expand Down

0 comments on commit 6de3812

Please sign in to comment.