Skip to content

Fix/remove w3c cli readme #97

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

Closed
RishabhS7 wants to merge 2 commits into from
Closed

Fix/remove w3c cli readme #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d1742b
fix: remove cli tool mentions
RishabhS7 Dec 26, 2025
dc90829
fix: package lock
RishabhS7 Dec 26, 2025
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)
Comment on lines +23 to +24

@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 | 🟠 Major

Replace generic link text with descriptive alternatives.

Always use descriptive, meaningful text that clearly indicates the link destination. Avoid generic phrases that provide no context about where the link leads. Generic [link] text violates accessibility standards and limits SEO effectiveness.

Replace each generic link with descriptive text based on the surrounding context:

🔎 Proposed fix for all non-descriptive links 
   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)
+      1. [Generate a signature-specific key pair.](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. [Generate and host a DID web identity.](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)
+          1. [Prepare and sign the VC payload.](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. [Verify the signed VC.](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)
+          1. [Prepare and sign the payload for credential status.](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)
+          1. [Prepare and sign the VC payload.](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)
+          1. [Verify the signed VC.](https://github.com/TrustVC/w3c/tree/main/packages/w3c-vc#2-verifying-a-credential)

This approach embeds the action verbs directly in the link text, improving both readability and accessibility.

Also applies to: 29-29, 31-31, 35-35, 37-37, 39-39

🧰 Tools
🪛 LanguageTool

[grammar] ~23-~23: Use a hyphen to join words.
Context: ... Requisite** 1. Generate a signature specific key pair. [link](https://github...

(QB_NEW_EN_HYPHEN)

🪛 markdownlint-cli2 (0.18.1)

23-23: Link text should be descriptive

(MD059, descriptive-link-text)

24-24: Link text should be descriptive

(MD059, descriptive-link-text)

🤖 Prompt for AI Agents 
In README.md around lines 23-24 (and also apply the same change at lines 29, 31,
35, 37, 39), replace the generic link text "[link]" with descriptive link text
that reflects the destination and action (for example "Create a
signature-specific key pair" or "Generate and host a DID web identity" or
similar phrasing drawn from the surrounding sentence), update each markdown link
so the visible text is meaningful and actionable for accessibility/SEO, and
ensure the new text remains concise and clear while preserving the original link
URL.


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 | 🔴 Critical

Fix the empty link placeholder.

Line 40 contains an incomplete empty link [link]() with no URL. Either provide the complete link or remove the entry if this reference is not yet available.

🔎 Proposed fix 
-      2. Verify the credentialStatus [link]()
+      2. Verify the credentialStatus. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-credential-status#verify-credential-status)

If the URL is unknown, consider removing this bullet point and adding it in a follow-up issue.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
2. Verify the credentialStatus [link]()
2. Verify the credentialStatus. [link](https://github.com/TrustVC/w3c/tree/main/packages/w3c-credential-status#verify-credential-status)
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

40-40: No empty links

(MD042, no-empty-links)

40-40: Link text should be descriptive

(MD059, descriptive-link-text)

🤖 Prompt for AI Agents 
In README.md around line 40, the bullet "Verify the credentialStatus [link]()"
contains an empty link; either replace the empty link with the correct URL to
the referenced documentation/resource, or remove the bracketed link entirely (or
replace it with a TODO/issue reference) so the entry no longer contains an empty
placeholder.


## 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