Skip to content
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

Improve README. #53

Merged
merged 1 commit into from
Dec 10, 2024
Merged

Improve README. #53

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
13 changes: 4 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,32 +15,27 @@ Provides interoperability tests for issuers and verifiers that support

## Install

```js
```sh
npm i
```

## Usage

```
```sh
npm test
```

## Generator

To generate new test data use this command:

```js
```sh
npm run generate-vcs
```

## Implementation

To add your implementation to this test suite see the
`w3c-ccg/vc-test-suite-implementations` [README](https://github.com/w3c-ccg/vc-test-suite-implementations/blob/main/README.md). Add the tags
`w3c/vc-test-suite-implementations` [README](https://github.com/w3c/vc-test-suite-implementations/blob/main/README.md). Add the tags
`BitstringStatusList` along with `Revocation` or `Suspension` to run your
issuer and verifier against this test suite.

Note: To run the tests, some implementations require client secrets that can be
passed as env variables to the test script. To see which ones require client
secrets, you can check configs in the `w3c-ccg/vc-test-suite-implementations`
repo.