Skip to content

Commit

Permalink
doc: Add the sd-jwt vc description in sdjwt.js.org (openwallet-founda…
Browse files Browse the repository at this point in the history
…tion#124)

Signed-off-by: Lukas <Lukas@hopae.io>
Signed-off-by: Lukas.J.Han <lukas.j.han@gmail.com>
Co-authored-by: Mirko Mollik <mirkomollik@gmail.com>
  • Loading branch information
lukasjhan and cre8 authored Mar 1, 2024
1 parent 94f33f1 commit 838c288
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 3 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ This is the reference implmentation of [IETF SD-JWT specification](https://data

Hopae, a founding member of OpenWallet Foundation, is building wallet module in TypeScript and need this project as a core component.

Currently compliant with: **draft-ietf-oauth-selective-disclosure-jwt-07**
Currently compliant with:

- **[draft-ietf-oauth-selective-disclosure-jwt-07](https://datatracker.ietf.org/doc/draft-ietf-oauth-selective-disclosure-jwt/)**
- **[draft-ietf-oauth-sd-jwt-vc-02](https://www.ietf.org/archive/id/draft-ietf-oauth-sd-jwt-vc-02.html)**

## **Background**

Expand Down Expand Up @@ -41,6 +44,7 @@ By adhering to these design principles, "Selective Disclosure for JWT" aims to s
## Packages

- **[@sd-jwt/core](./packages/core/README.md)**: Core library for selective disclosure JWTs
- **[@sd-jwt/sd-jwt-vc](./packages/sd-jwt-vc/README.md)**: SD-JWT VC format based on the core functions
- **[@sd-jwt/decode](./packages/decode/README.md)**: Decode SD JWT into objects
- **[@sd-jwt/present](./packages/present/README.md)**: Present SD JWT
- **[@sd-jwt/utils](./packages/utils/README.md)**: Utility functions for SD JWT
Expand Down
22 changes: 20 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,28 @@ <h2 class="text-2xl font-bold mb-4">What is SD JWT?</h2>
>> Try it Online</a
>
</p>
<h2 class="text-2xl font-bold mb-4">Installation</h2>
<h2 class="text-2xl font-bold mb-4">What is SD-JWT VC?</h2>
<p class="mb-4">
SD-JWT VC describes data formats as well as validation and processing rules to
express Verifiable Credentials with JSON payloads with and without
selective disclosure based on the SD-JWT. You can check the details in <a
href="https://datatracker.ietf.org/doc/draft-ietf-oauth-sd-jwt-vc/"
class="text-blue-700 hover:underline"
target="_blank"
>IETF SD-JWT VC specification</a>
</p>
<p class="mb-4">
Currently compliant with: <b>draft-ietf-oauth-selective-disclosure-jwt-07</b>
Note: We are provide both SD-JWT and SD-JWT VC. The library can be used to create sd-jwt based credentials.
To be compliant with the `sd-jwt-vc` standard, you can use the `@sd-jwt/sd-jwt-vc` that is implementing this spec.
</p>
<h2 class="text-2xl font-bold mb-4">Specification Compliance</h2>
<div class="mb-4">
<ul class="list-disc pl-5 space-y-2">
<li>SD-JWT: <b>draft-ietf-oauth-selective-disclosure-jwt-07</b></li>
<li>SD-JWT VC: <b>draft-ietf-oauth-sd-jwt-vc-02</b></li>
</ul>
</div>
<h2 class="text-2xl font-bold mb-4">Installation</h2>
<p class="mb-4">
<div class="bg-gray-800 text-blue-200 font-mono text-sm p-4 rounded-lg overflow-x-auto my-6">
<pre>$ npm install @sd-jwt/sd-jwt-vc</pre>
Expand Down

0 comments on commit 838c288

Please sign in to comment.