dan/jose
1
0
Fork 0
mirror of https://github.com/danbulant/jose synced 2026-05-23 06:18:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: include new features

Browse source
This commit is contained in:
Filip Skokan 2020-12-16 15:10:43 +01:00
parent 6fb862cf12
commit 4e1ede4dbb
2 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -41,8 +41,8 @@ npm install jose@3
- Encryption - [Compact](docs/classes/_jwe_compact_encrypt_.compactencrypt.md#readme), [Flattened](docs/classes/_jwe_flattened_encrypt_.flattenedencrypt.md#readme)
- Decryption - [Compact](docs/functions/_jwe_compact_decrypt_.compactdecrypt.md#readme), [Flattened](docs/functions/_jwe_flattened_decrypt_.flatteneddecrypt.md#readme)
- JSON Web Signature (JWS)
- Signing - [Compact](docs/classes/_jws_compact_sign_.compactsign.md#readme), [Flattened](docs/classes/_jws_flattened_sign_.flattenedsign.md#readme)
- Verification - [Compact](docs/functions/_jws_compact_verify_.compactverify.md#readme), [Flattened](docs/functions/_jws_flattened_verify_.flattenedverify.md#readme)
- Signing - [Compact](docs/classes/_jws_compact_sign_.compactsign.md#readme), [Flattened](docs/classes/_jws_flattened_sign_.flattenedsign.md#readme), [General](docs/classes/_jws_general_sign_.generalsign.md#readme)
- Verification - [Compact](docs/functions/_jws_compact_verify_.compactverify.md#readme), [Flattened](docs/functions/_jws_flattened_verify_.flattenedverify.md#readme), [General](docs/functions/_jws_general_verify_.generalverify.md#readme)
- JSON Web Key (JWK)
- [Parsing (JWK to KeyLike)](docs/functions/_jwk_parse_.parsejwk.md#readme)
- [Conversion (KeyLike to JWK)](docs/functions/_jwk_from_key_like_.fromkeylike.md#readme)
@ -53,6 +53,8 @@ npm install jose@3
- Key Pair or Secret Generation
- [Asymmetric Key Pair Generation](docs/functions/_util_generate_key_pair_.generatekeypair.md#readme)
- [Symmetric Secret Generation](docs/functions/_util_generate_secret_.generatesecret.md#readme)
- Utilities
- [Decoding Token's Protected Header](docs/functions/_util_decode_protected_header_.decodeprotectedheader.md#readme)
- [Unsecured JWT](docs/classes/_jwt_unsecured_.unsecuredjwt.md#readme)
- [JOSE Errors](docs/modules/_util_errors_.md)
@ -72,7 +74,7 @@ A continuously growing list of examples is available in the [tracker](https://gi
| Serialization | JWS Sign | JWS Verify | JWE Encrypt | JWE Decrypt |
| -- | -- | -- | -- | -- |
| Compact | ✓ | ✓ | ✓ | ✓ |
| General JSON | ✕ | ✕ | ✕ | ✕ |
| General JSON | ✓ | ✓ | ✕ | ✕ |
| Flattened JSON | ✓ | ✓ | ✓ | ✓ |
| JWT Sign | JWT Verify | JWT Encrypt | JWT Decrypt |

6
docs/README.md
View file

@ -18,8 +18,8 @@ If you or your business use `jose`, please consider becoming a [sponsor][support
- Encryption - [Compact](classes/_jwe_compact_encrypt_.compactencrypt.md#readme), [Flattened](classes/_jwe_flattened_encrypt_.flattenedencrypt.md#readme)
- Decryption - [Compact](functions/_jwe_compact_decrypt_.compactdecrypt.md#readme), [Flattened](functions/_jwe_flattened_decrypt_.flatteneddecrypt.md#readme)
- JSON Web Signature (JWS)
- Signing - [Compact](classes/_jws_compact_sign_.compactsign.md#readme), [Flattened](classes/_jws_flattened_sign_.flattenedsign.md#readme)
- Verification - [Compact](functions/_jws_compact_verify_.compactverify.md#readme), [Flattened](functions/_jws_flattened_verify_.flattenedverify.md#readme)
- Signing - [Compact](classes/_jws_compact_sign_.compactsign.md#readme), [Flattened](classes/_jws_flattened_sign_.flattenedsign.md#readme), [General](classes/_jws_general_sign_.generalsign.md#readme)
- Verification - [Compact](functions/_jws_compact_verify_.compactverify.md#readme), [Flattened](functions/_jws_flattened_verify_.flattenedverify.md#readme), [General](functions/_jws_general_verify_.generalverify.md#readme)
- JSON Web Key (JWK)
- [Parsing (JWK to KeyLike)](functions/_jwk_parse_.parsejwk.md#readme)
- [Conversion (KeyLike to JWK)](functions/_jwk_from_key_like_.fromkeylike.md#readme)
@ -30,6 +30,8 @@ If you or your business use `jose`, please consider becoming a [sponsor][support
- Key Pair or Secret Generation
- [Asymmetric Key Pair Generation](functions/_util_generate_key_pair_.generatekeypair.md#readme)
- [Symmetric Secret Generation](functions/_util_generate_secret_.generatesecret.md#readme)
- Utilities
- [Decoding Token's Protected Header](functions/_util_decode_protected_header_.decodeprotectedheader.md#readme)
- [Unsecured JWT](classes/_jwt_unsecured_.unsecuredjwt.md#readme)
- [JOSE Errors](modules/_util_errors_.md)