From e43c604e028e880b2c6db1c2401d7249da1c6958 Mon Sep 17 00:00:00 2001
From: toanNgo <toan.ngo@gosource.com.au>
Date: Tue, 20 Jun 2023 14:28:58 +0700
Subject: [PATCH] docs: add read me

Signed-off-by: toanNgo <toan.ngo@gosource.com.au>
---
 packages/vc-api/README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 packages/vc-api/README.md

diff --git a/packages/vc-api/README.md b/packages/vc-api/README.md
new file mode 100644
index 00000000..8ee2e03a
--- /dev/null
+++ b/packages/vc-api/README.md
@@ -0,0 +1,39 @@
+# vc-api agent router
+
+- This agent router conform to vc-api standard that to achieve interoperability's goal between various parties.
+
+## Usage
+
+- This plugin follow the `veramo` architecture , so you can configure it with `agent.yml`
+
+```jsx
+# API base path
+    - - /issuer
+      - $require: '@vckit/vc-api-issuer?t=function#AgentRouter'
+        $args:
+          - createCredential: createVerifiableCredential
+            updateCredentialStatus: updateVerifiableCredentialStatus
+```
+
+## Test with test-suite
+
+- Clone the test suite: https://github.com/w3c-ccg/vc-api-issuer-test-suite
+- Go to `node_modules/vc-api-test-suite-implementations/implementations` , create files except the index file
+- Create new implementation file:
+
+```jsx
+{
+  "name": "GoSource",
+  "implementation": "GoSource Verifiable Credentials",
+  "issuers": [{
+    "id": "YOUR_DID_MANAGED_BY_YOUR_KMS",
+    "endpoint": "http://localhost:3332/agent/credentials/issue",
+    "options": {
+      "type": "Ed25519Signature2020"
+    },
+    "tags": ["vc-api", "Ed25519Signature2020"]
+  }]
+}
+```
+
+- Run the test command `npm run test`