diff --git a/README.md b/README.md index 29e1e2a..a536897 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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 ``` @@ -108,6 +111,7 @@ const DIDDocKeyHandling = async(): Promise => { DIDDocKeyHandling(); ```` + ### DIDDocument creation ````typescript @@ -252,6 +256,7 @@ const createDIDDocument = async (): Promise => { createDIDDocument(); ```` + ## API TODO: add API description