From 681e4bfc5bc301e9161114d2467a5508a670a763 Mon Sep 17 00:00:00 2001 From: David McFadzean Date: Wed, 27 Mar 2024 15:41:46 -0400 Subject: [PATCH] Added links to docs --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6b10ee9b..4364170a 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,15 @@ -# Quick start +# kc + +kc is the reference implementation of the Multi Dimensional Identity Protocol ([MDIP](doc/DID-scheme/README.md)). +Details on each command can be found in the [CLI User Manual](doc/CLI-user-manual/README.md). + +## Quick start requires: node v18 ``` -$ git clone https://github.com/KeychainMDIP/keychain-cli -$ cd keychain-cli +$ git clone https://github.com/KeychainMDIP/kc +$ cd kc $ npm install ``` @@ -76,3 +81,4 @@ Commands: verify-file Verify the signature in a JSON file verify-response Decrypt and validate a Verifiable Presentation ``` +