Skip to content
This repository has been archived by the owner on Jan 2, 2024. It is now read-only.

Commit

Permalink
Merge remote-tracking branch 'origin/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
atz3n committed Jul 30, 2020
2 parents 3d82fa2 + dd28f10 commit 4210c03
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ A library for DID Document creation.

The purpose of this library is to assist in the creation of DID documents that comply with the decentralized identifier [specification](https://www.w3.org/TR/2020/WD-did-core-20200723/).


## Table of Contents

- [did-document-ts](#did-document-ts)
Expand All @@ -17,12 +18,14 @@ The purpose of this library is to assist in the creation of DID documents that c
- [Contributing](#contributing)
- [License](#license)


## Security

The DIDDocKey module uses [Digital Bazaars](https://github.com/digitalbazaar) [crypto-ld](https://github.com/digitalbazaar/crypto-ld) library for key handling. The key material exported by DIDDocKeys `exportKeyMaterial` function is compatible to the key material exported by [LDKeyPairs](https://github.com/digitalbazaar/crypto-ld/blob/master/lib/LDKeyPair.js) `export` function. The generated keys can later be used within Digital Bazaars crypto suit.

crypto-ld is licensed under the [new BSD License (3-clause)](https://github.com/digitalbazaar/crypto-ld/blob/master/LICENSE).


## Install

```
Expand Down Expand Up @@ -108,6 +111,7 @@ const DIDDocKeyHandling = async(): Promise<void> => {
DIDDocKeyHandling();
````


### DIDDocument creation

````typescript
Expand Down Expand Up @@ -252,6 +256,7 @@ const createDIDDocument = async (): Promise<void> => {
createDIDDocument();
````


## API

TODO: add API description
Expand Down

0 comments on commit 4210c03

Please sign in to comment.