From 7477458b18aa19ba35400b52f7bd5c93e4a2d04f Mon Sep 17 00:00:00 2001 From: James Ebert Date: Thu, 18 Apr 2024 22:32:21 -0700 Subject: [PATCH] Simple documentation fixes (#1181) * adjust didpeer docs, aries readme mobile components * fix: adjust mobile-demo path Signed-off-by: James Ebert --------- Signed-off-by: James Ebert --- aries/README.md | 15 +++++++++------ did_core/did_methods/did_peer/README.md | 19 ++++++++++++------- 2 files changed, 21 insertions(+), 13 deletions(-) diff --git a/aries/README.md b/aries/README.md index 90b707a983..98afe0f58c 100644 --- a/aries/README.md +++ b/aries/README.md @@ -1,11 +1,14 @@ # Hyperledger Aries logo Aries components ## Aries components - - [`aries_vcx`](aries_vcx) - Library implementing DIDComm protocols, with focus on verifiable credential issuance and verification. - - [`messages`](messages) - Library for building and parsing Aries messages. - - [`aries_vcx_core`](aries_vcx_core) - Interfaces for interaction with ledgers, wallets and credentials. - - [`aries-vcx-agent`](agents/rust/aries-vcx-agent) - simple aries agent framework built on top of `aries_vcx` library. - - [`mediator`](agents/rust/mediator) - Aries message mediator service + +- [`aries_vcx`](aries_vcx) - Library implementing DIDComm protocols, with focus on verifiable credential issuance and verification. +- [`messages`](messages) - Library for building and parsing Aries messages. +- [`aries_vcx_core`](aries_vcx_core) - Interfaces for interaction with ledgers, wallets and credentials. +- [`aries-vcx-agent`](agents/rust/aries-vcx-agent) - simple aries agent framework built on top of `aries_vcx` library. +- [`mediator`](agents/rust/mediator) - Aries message mediator service ## Aries mobile 📱 components - - [`../tools/uniffi_aries_vcx`](../uniffi_aries_vcx) - UniFFI wrapper for `aries_vcx` and sample mobile app + +- [`uniffi-aries-vcx`](wrappers/uniffi-aries-vcx) - UniFFI wrapper for `aries_vcx`. +- [`mobile-demo`](agents/mobile_demo/) - Sample Android App using UniFFI wrapper. diff --git a/did_core/did_methods/did_peer/README.md b/did_core/did_methods/did_peer/README.md index dda1b971f9..49e5db4178 100644 --- a/did_core/did_methods/did_peer/README.md +++ b/did_core/did_methods/did_peer/README.md @@ -1,31 +1,36 @@ # did_peer ## Overview -Rust crate for creation, parsing, validation, and resolution of [Peer DIDs](https://identity.foundation/peer-did-method-spec). -Peer DIDs are a special type of decentralized identifiers designed for direct peer-to-peer interactions, without the + +Rust crate for creation, parsing, validation, and resolution of [Peer DIDs](https://identity.foundation/peer-did-method-spec). +Peer DIDs are a special type of decentralized identifiers designed for direct peer-to-peer interactions, without the need for a blockchain or other centralized registry. ## Features -- **Numalgo Support**: The library implements various version of did:peer. The different versions are referred to as "numalgos". - Currently supports numalgo 1, 2, and 3. + +- **Numalgo Support**: The library implements various version of did:peer. The different versions are referred to as "numalgos". + Currently supports numalgo 1, 2, 3, and 4. - **DID Parsing**: Capability to parse `did:peer` strings, ensuring they comply with the Peer DID specifications. - **DID Creation from DIDDoc**: Functionality to create `did:peer` identifiers from DID documents. - **Numalgo Conversion**: Ability to convert between different numalgos, specifically from Numalgo 2 to Numalgo 3. - **Validation**: Verification that DIDs adhere to the required specifications and format. ## Getting Started + ### Installation + Add the Peer DID library as a dependency in your `Cargo.toml` file: + ```toml [dependencies] peer_did = { tag = "0.63.0", git = "https://github.com/hyperledger/aries-vcx" } ``` ## Demo -To get you off the ground, have a look at the [demo](examples/demo.rs). It demonstrates how to create, parse. You can + +To get you off the ground, have a look at the [demo](examples/demo.rs). It demonstrates how to create, parse. You can run the demo with the following command: + ```bash cargo run --example demo ``` - -