Skip to content

Commit

Permalink
chore: Update main readme to include the new plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
nklomp committed Dec 16, 2021
1 parent 6db9863 commit a5aefde
Showing 1 changed file with 34 additions and 7 deletions.
41 changes: 34 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,30 +21,57 @@ multiple packages (see lerna below). It contains plugins that extend the Veramo
- DIDs and Key management:
- factom: [Factom DID creation](./packages/lto-did-provider/README.md) (WIP)
- lto: [LTO Network DID creation and Verification Methods](./packages/lto-did-provider/README.md)
- VC (HTTP) API:
- mnemonic-seed: [Mnemonic Seed and Key Derivation](./packages/mnemonic-info-generator/README.md)
- Verifiable Credentials and Presentations:
- VC API Issuer: [Issue VCs using the VC (HTTP) Api v0.1](./packages/vc-api-issuer/README.md)
- VC API Verifier: [Verify VCs and VPs using the VC (HTTP) Api v0.1](./packages/vc-api-verifier/README.md)
- Self Issued OpenID Connect v2 and OpenID Connect for Verifiable Presentations
- SIOPv2 (WIP)
- Json-LD VC handler: [Issues and verifies JSON-LD based VCs and VPs](./packages/vc-handler-ld-local/README.md)
- OpenID Connect:
- SIOPv2 and
OIDC4VP: [Self-Issued OpenID Connect and OpenID Connect for Verifiable Presentations](./packages/did-auth-siop-op-authenticator/README.md)

## SSI SDK Core

The [core package](./packages/ssi-sdk-core/README.md) contains types and methods shared by the other plugins

## Factom DID Provider

The [Factom Protocol DID Provider](./packages/factom-did-provider/README.md) is a Veramo plugin to create DIDs on the
Factom Protocol.

## LTO Network DID Provider

The [LTO Network DID Provider](./packages/lto-did-provider/README.md) is a Veramo plugin to create DIDs and to add and
manage verification methods on LTO Network.

## Mnemonic Seed

The [Mnemonic Seed and Key Derivation](./packages/mnemonic-info-generator/README.md) handles generations, secure storage
of Mnemonics, the creation of a seed out of it and the derivation of keys

## VC API Issuer
The [W3C VC (HTTP) API Issuer](./packages/factom-did-provider/README.md) is a Veramo plugin to issue Verifiable Credentials
using a [W3C VC API](https://github.com/w3c-ccg/vc-api) spec based API (currently only supporting a v0.1 spec).

The [W3C VC (HTTP) API Issuer](./packages/factom-did-provider/README.md) is a Veramo plugin to issue Verifiable
Credentials using a [W3C VC API](https://github.com/w3c-ccg/vc-api) spec based API (currently only supporting a v0.1
spec).

## VC API Verifier

The [W3C VC (HTTP) API Verifier](./packages/factom-did-provider/README.md) is a Veramo plugin to verify Verifiable
Credentials using a [W3C VC API](https://github.com/w3c-ccg/vc-api) spec based API (currently only supporting a v0.1 spec).
Credentials using a [W3C VC API](https://github.com/w3c-ccg/vc-api) spec based API (currently only supporting a v0.1
spec).

## JSON-LD VC/VP Handler

The [JSON-LD VC/VP Handler](./packages/vc-handler-ld-local/README.md) handles issuance and verificaiton of JSON-LD based
Verifiable Credentials and Verifiable Presentations

## OpenID Connect

The [Self-Issued OpenID Connect and OpenID Connect for Verifiable Presentations](./packages/did-auth-siop-op-authenticator/README.md)
plugin allows an OP to authenticate against a Relying Party using Self-Issued OpenID Connect and optionally OpenID
Connect for Verifiable Presentations, with the help of
our [Presentation-Exchange library](https://github.com/Sphereon-Opensource/pe-js).

## DID resolution

Expand All @@ -64,7 +91,6 @@ export const agent = createAgent<IDIDManager & CredentialIssuerLD & IKeyManager
})
````


## Building and testing

### Lerna
Expand All @@ -73,6 +99,7 @@ The SSI-SDK makes use of Lerna for managing multiple packages. Lerna is a tool t
managing multi-package repositories with git and npm / yarn.

### Build

The below command builds all packages for you using lerna

```shell
Expand Down

0 comments on commit a5aefde

Please sign in to comment.