Skip to content

fix: remove w3c cli tool mention #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rongquan1 merged 1 commit into from
Dec 26, 2025
Merged

fix: remove w3c cli tool mention #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 25 additions & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,46 +1,46 @@
# TrustVC W3C

## About

A wrapper lib build for TrustVC to work with W3C [Verifiable Credentials](https://www.w3.org/TR/vc-data-model/) (VCs) Data Model v1.1. Provides packages to facilitate the creation of [Decentralized Identifiers](https://www.w3.org/TR/did-core/) (DIDs) v1, specifically [`did:web`](https://w3c-ccg.github.io/did-method-web/), and [Verifiable Credentials Status](https://www.w3.org/TR/2023/WD-vc-status-list-20230427/) Status List v2021.

## Packages

For more details on each packages, refer to the individual README doc.

| Packages | npm |
| --- | --- |
| [@trustvc/w3c](https://github.com/TrustVC/w3c/tree/main/packages/w3c) | [npm](https://www.npmjs.com/package/@trustvc/w3c) |
| [@trustvc/w3c-context](https://github.com/TrustVC/w3c/tree/main/packages/w3c-context) | [npm](https://www.npmjs.com/package/@trustvc/w3c-context) |
| Packages | npm |
| --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
| [@trustvc/w3c](https://github.com/TrustVC/w3c/tree/main/packages/w3c) | [npm](https://www.npmjs.com/package/@trustvc/w3c) |
| [@trustvc/w3c-context](https://github.com/TrustVC/w3c/tree/main/packages/w3c-context) | [npm](https://www.npmjs.com/package/@trustvc/w3c-context) |
| [@trustvc/w3c-credential-status](https://github.com/TrustVC/w3c/tree/main/packages/w3c-credential-status) | [npm](https://www.npmjs.com/package/@trustvc/w3c-credential-status) |
| [@trustvc/w3c-issuer](https://github.com/TrustVC/w3c/tree/main/packages/w3c-issuer) | [npm](https://www.npmjs.com/package/@trustvc/w3c-issuer) |
| [@trustvc/w3c-vc](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc) | [npm](https://www.npmjs.com/package/@trustvc/w3c-vc) |

## Tools
| Apps | Link |
| --- | --- |
| [@trustvc/w3c-cli](https://github.com/TrustVC/w3c/tree/main/apps/w3c-cli) | [npm](https://www.npmjs.com/package/@trustvc/w3c-cli) |
| [@trustvc/w3c-issuer](https://github.com/TrustVC/w3c/tree/main/packages/w3c-issuer) | [npm](https://www.npmjs.com/package/@trustvc/w3c-issuer) |
| [@trustvc/w3c-vc](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc) | [npm](https://www.npmjs.com/package/@trustvc/w3c-vc) |

## Getting Started
## Getting Started

1. **Pre Requisite**
1. Generate a signature specific key pair. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-issuer#1-create-private-key)
2. Generate and host a DID web identity. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-issuer#2-generate-did-key-pair-and-did-document)

1. Generate a signature specific key pair. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-issuer#1-create-private-key)
2. Generate and host a DID web identity. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-issuer#2-generate-did-key-pair-and-did-document)

2. **Sign and Verify VC**
1. Sign
1. Prepare and Sign the VC payload. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#1-signing-a-credential)
2. Verify
1. Verify the signed VC. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#2-verifying-a-credential)

1. Sign
1. Prepare and Sign the VC payload. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#1-signing-a-credential)
2. Verify
1. Verify the signed VC. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#2-verifying-a-credential)

3. **Sign and Verify VC with Credential Status**
1. Generate Credential Status
1. Prepare and Sign the payload for Credential Status. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-credential-status#w3c-credential-status)
2. Sign
1. Prepare and Sign the VC payload. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#1-signing-a-credential)
3. Verify
1. Verify the signed VC. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#2-verifying-a-credential)
2. Verify the credentialStatus [link]()
1. Generate Credential Status
1. Prepare and Sign the payload for Credential Status. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-credential-status#w3c-credential-status)
2. Sign
1. Prepare and Sign the VC payload. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#1-signing-a-credential)
3. Verify
1. Verify the signed VC. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#2-verifying-a-credential)
2. Verify the credentialStatus [link]()

@coderabbitai coderabbitai Bot Dec 26, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Complete the broken link placeholder.

Line 40 has an incomplete link with an empty URL: [link](). Either provide the valid URL reference for verifying credentialStatus or remove the placeholder.

🤖 Prompt for AI Agents 
In README.md around line 40, the credentialStatus verification link is a broken
placeholder "[link]()", so replace the empty URL with the correct verification
URL (or a relative doc anchor) or remove the placeholder entirely; update the
markdown so the line either reads "2. Verify the credentialStatus [correct-URL]"
with a valid target or simply "2. Verify the credentialStatus" if no link is
available.


## Running the code

```
npm install
npm run build
Expand Down
101 changes: 59 additions & 42 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading