Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jchartrand committed Nov 28, 2024
1 parent b977640 commit 3c40789
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ IMPORTANT NOTE ABOUT VERSIONING: If you are using a Docker Hub image of this rep

Use this express server to verify a [Verifiable Credential](https://www.w3.org/TR/vc-data-model/) or a [Verifiable Presentation](https://www.w3.org/TR/vc-data-model-2.0/#presentations). This is a conforming implemetation of the [VC-API Specification](https://w3c-ccg.github.io/vc-api/).

Implements three http endpoints:
Implements two [VC-API](https://w3c-ccg.github.io/vc-api/) endpoints:

* POST /credentials/verify

Expand All @@ -38,6 +38,8 @@ Which verifies a [Verifiable Credential](https://www.w3.org/TR/vc-data-model/) t

Which verifies a [Verifiable Presentation](https://www.w3.org/TR/vc-data-model-2.0/#presentations) that has been posted to it, as defined by the [VC-API Specification](https://w3c-ccg.github.io/vc-api/#verify-presentation)

Also provides a health check endpoint:

* GET /healthz

Which is an endpoint typically meant to be called by the Docker [HEALTHCHECK](https://docs.docker.com/reference/dockerfile/#healthcheck) option for a specific service. Read more below in the [Health Check](#health-check) section.
Expand Down Expand Up @@ -90,7 +92,7 @@ So that a verifier knows that a credential was signed by a key that is really ow

The DCC provides a number of registries that are pre-configured to work with this verifier. The DCC registries use Github for storage. To request that your [DID](https://www.w3.org/TR/did-core/) be added to a registry, submit a pull request in which you've added your [DID](https://www.w3.org/TR/did-core/) to the registry file.

You can also use different registries by following the example of the DCC [issuer-registry-client](https://github.com/digitalcredentials/issuer-registry-client) to create your own registry client and then simply import that in package.json.
You can use different registries by following the examples in the [.knownDidRegistries.js file](.knownDidRegistries.js) to add your own registries and/or remove the DCC registries.

## Usage

Expand Down

0 comments on commit 3c40789

Please sign in to comment.