From 6d43d033d2bb3019c9fe4fa000cde6afbdccc8e2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Javier=20Rib=C3=B3?= Date: Thu, 1 Jun 2023 10:38:55 +0200 Subject: [PATCH] fix: Documentation improvements (#62) --- docs/Agent.md | 14 ++++++++------ docs/index.md | 14 -------------- 2 files changed, 8 insertions(+), 20 deletions(-) diff --git a/docs/Agent.md b/docs/Agent.md index ffe3d64a2..e7ba21490 100644 --- a/docs/Agent.md +++ b/docs/Agent.md @@ -8,15 +8,17 @@ proof presentation, issue credentials, and out-of-band messages. DIDComm-related functionality comes from the [DIDComm V2](https://github.com/input-output-hk/atala-prism-docs/blob/main/documentation/docs/concepts/glossary.md#didcomm) specification. ## DIDComm Protocol Support - | Protocol | Supported | Notes | | --- | :--: | -- | | [Mediator Coordinator](https://didcomm.org/mediator-coordination/2.0/) | :white_check_mark: | -- | -| Connection | :white_check_mark: | -- | -| [DIDComm V2 Issue Credential](https://github.com/decentralized-identity/waci-didcomm/tree/main/issue_credential) | : -white_check_mark: | -- | -| [DIDComm V2 Present Proof](https://github.com/decentralized-identity/waci-didcomm/blob/main/present_proof/present-proof-v3.md) -| :white_check_mark: | -- | +| Connection | :white_check_mark: | Atala PRISM proprietary | +| [DIDComm V2 Issue Credential](https://github.com/decentralized-identity/waci-didcomm/tree/main/issue_credential) | :white_check_mark: | -- | +| [DIDComm V2 Present Proof](https://github.com/decentralized-identity/waci-didcomm/blob/main/present_proof/present-proof-v3.md) | :white_check_mark: | -- | + +### How to use didcomm inside your webpack application +It is required for you to copy the wasm file "didcomm-rust/didcomm-browser/didcomm_js_bg.wasm" +inside the public folder that your react application has, usually "./public". +It is important also to keep the filename as it comes, without changing anything to it. ## Agent Setup diff --git a/docs/index.md b/docs/index.md index 83d6095ec..4af66a889 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,17 +10,3 @@ Atala PRISM TypeScript SDK provides the following building blocks: * Mercury: Provides a suite of operations for handling DIDComm V2 messages. * Pluto: Provides an interface for storage operations in a portable, storage-agnostic manner. * PrismAgent: PrismAgent, a component using all other building blocks, provides basic edge agent capabilities, including implementing DIDComm V2 protocols. - -## DIDComm Protocol Support - -| Protocol | Supported | Notes | -| --- | :--: | -- | -| [Mediator Coordinator](https://didcomm.org/mediator-coordination/2.0/) | :white_check_mark: | -- | -| Connection | :white_check_mark: | Atala PRISM proprietary | -| [DIDComm V2 Issue Credential](https://github.com/decentralized-identity/waci-didcomm/tree/main/issue_credential) | :white_check_mark: | -- | -| [DIDComm V2 Present Proof](https://github.com/decentralized-identity/waci-didcomm/blob/main/present_proof/present-proof-v3.md) | :white_check_mark: | -- | - -### How to use didcomm inside your webpack application -It is required for you to copy the wasm file "didcomm-rust/didcomm-browser/didcomm_js_bg.wasm" -inside the public folder that your react application has, usually "./public". -It is important also to keep the filename as it comes, without changing anything to it.