Skip to content

Commit

Permalink
doc: change link to main branch (openwallet-foundation#187)
Browse files Browse the repository at this point in the history
Signed-off-by: Lukas.J.Han <[email protected]>
Co-authored-by: Mirko Mollik <[email protected]>
  • Loading branch information
lukasjhan and cre8 authored Mar 23, 2024
1 parent 2e92cb3 commit 30a3253
Show file tree
Hide file tree
Showing 9 changed files with 16 additions and 12 deletions.
2 changes: 1 addition & 1 deletion packages/browser-crypto/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Ensure you have Node.js installed as a prerequisite.

### Usage

Check out more details in our [documentation](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/next/docs) or [examples](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/next/examples)
Check out more details in our [documentation](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/main/docs) or [examples](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/main/examples)

### Dependencies

Expand Down
3 changes: 2 additions & 1 deletion packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,12 @@ Ensure you have Node.js installed as a prerequisite.

### Usage

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.
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.
If you want to use the pure sd-jwt class or implement your own sd-jwt credential approach, you can use this library.

### Dependencies

- @sd-jwt/decode
- @sd-jwt/present
- @sd-jwt/types
- @sd-jwt/utils
2 changes: 1 addition & 1 deletion packages/decode/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Ensure you have Node.js installed as a prerequisite.

### Usage

Check out more details in our [documentation](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/next/docs) or [examples](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/next/examples)
Check out more details in our [documentation](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/main/docs) or [examples](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/main/examples)

### Dependencies

Expand Down
2 changes: 1 addition & 1 deletion packages/hash/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Ensure you have Node.js installed as a prerequisite.

### Usage

Check out more details in our [documentation](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/next/docs) or [examples](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/next/examples)
Check out more details in our [documentation](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/main/docs) or [examples](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/main/examples)

### Dependencies

Expand Down
2 changes: 1 addition & 1 deletion packages/node-crypto/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Ensure you have Node.js installed as a prerequisite.

### Usage

Check out more details in our [documentation](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/next/docs) or [examples](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/next/examples)
Check out more details in our [documentation](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/main/docs) or [examples](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/main/examples)

### Dependencies

Expand Down
2 changes: 1 addition & 1 deletion packages/present/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Ensure you have Node.js installed as a prerequisite.

### Usage

Check out more details in our [documentation](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/next/docs) or [examples](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/next/examples)
Check out more details in our [documentation](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/main/docs) or [examples](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/main/examples)

### Dependencies

Expand Down
11 changes: 7 additions & 4 deletions packages/sd-jwt-vc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,13 @@ Here's a basic example of how to use this library:
import { DisclosureFrame } from '@sd-jwt/sd-jwt-vc';

// identifier of the issuer
const iss = "University";
const iss = 'University';

// issuance time
const iat = new Date().getTime() / 1000;

//unique identifier of the schema
const vct = "University-Degree";
const vct = 'University-Degree';

// Issuer defines the claims object with the user's information
const claims = {
Expand All @@ -61,7 +61,10 @@ const disclosureFrame: DisclosureFrame<typeof claims> = {

// Issuer issues a signed JWT credential with the specified claims and disclosure frame
// returns an encoded JWT
const credential = await sdjwt.issue({iss, iat, vct, ...claims}, disclosureFrame);
const credential = await sdjwt.issue(
{ iss, iat, vct, ...claims },
disclosureFrame,
);

// Holder may validate the credential from the issuer
const valid = await sdjwt.validate(credential);
Expand All @@ -78,7 +81,7 @@ const presentation = await sdjwt.present(credential, presentationFrame);
const verified = await sdjwt.verify(presentation);
```

Check out more details in our [documentation](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/next/docs) or [examples](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/next/examples)
Check out more details in our [documentation](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/main/docs) or [examples](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/main/examples)

### Dependencies

Expand Down
2 changes: 1 addition & 1 deletion packages/types/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Ensure you have Node.js installed as a prerequisite.

### Usage

Check out more details in our [documentation](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/next/docs) or [examples](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/next/examples)
Check out more details in our [documentation](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/main/docs) or [examples](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/main/examples)

### Dependencies

Expand Down
2 changes: 1 addition & 1 deletion packages/utils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Ensure you have Node.js installed as a prerequisite.

### Usage

Check out more details in our [documentation](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/next/docs) or [examples](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/next/examples)
Check out more details in our [documentation](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/main/docs) or [examples](https://github.com/openwallet-foundation-labs/sd-jwt-js/tree/main/examples)

### Dependencies

Expand Down

0 comments on commit 30a3253

Please sign in to comment.