Skip to content

Commit

Permalink
Update readmes (#1024)
Browse files Browse the repository at this point in the history
* Update readmes

Signed-off-by: Patrik Stas <patrik.stas@absa.africa>
Signed-off-by: Miroslav Kovar <miroslav.kovar@absa.africa>
Co-authored-by: Miroslav Kovar <miroslav.kovar@absa.africa>
  • Loading branch information
Patrik-Stas and mirgee authored Oct 24, 2023
1 parent 1a414f0 commit dbaac13
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 18 deletions.
29 changes: 14 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,22 @@
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Join the chat at https://chat.hyperledger.org/channel/aries](https://img.shields.io/badge/Chat%20on-Hyperledger%20Chat-blue)](https://chat.hyperledger.org/channel/aries)

The repository contains
- Rust library `aries-vcx` implementing Aries protocols,
- collection of supporting projects.
The repository contains a set of crates to build [Aries](https://github.com/hyperledger/aries-rfcs/) / [DIDComm](https://didcomm.org/) applications in Rust.

## If you are Rust 🦀 developer
You can build your Rust project on top of
- [`aries-vcx`](aries_vcx) - ready to go Rust library to work with Aries protocols for didcomm, VC issuance and verification.
## 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` - Interfaces for interaction with ledgers, wallets and credentials.
- [`agents`](agents/rust) - Aries agents built on top of `aries_vcx`.

## General components
- `did_parser` - Building and parsing [DIDs](https://w3c.github.io/did-core/).
- `did_doc` - Building and parsing DID Documents.
- `did_peer`, `did_sov`, `did_web`, `did_key` - DID resolvers for different [DID methods](https://w3c.github.io/did-spec-registries/#did-methods).

Additionally, `aries-vcx` is built on top of smaller Rust crates which are part of this repo:
- [`aries_vcx_core`](aries_vcx_core) - foundational APIs to interact with ledger, wallet and anoncreds.
- [`messages`](messages) - crate for building and parsing Aries messages
- [`did_doc`](diddoc) - crate to work with DIDDocs

## If you are mobile 📱 developer
Aries-vcx can be used to build native mobile applications. You can write part of your mobile backend in Rust on top of
`aries-vcx` crate. Then expose FFI API for iOS/android environments.
- There's POC in progress [`uniffi_aries_vcx`](./uniffi_aries_vcx) using UniFFI library to autogenerate Swift and Kotlin wrappers.
## Mobile 📱
- [`uniffi_aries_vcx`](./uniffi_aries_vcx) - UniFFI wrapper for `aries_vcx` and sample mobile app
- [`simple_message_relay`](./tools/simple_message_relay) - simple implementation of message relay service for development / testing purposes

# Reach out 👋
- Ask a question on [discord](https://discord.com/channels/905194001349627914/955480822675308604)
Expand Down
4 changes: 4 additions & 0 deletions agents/rust/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Rust agents
This directory contains some of Rust agents built on top of the `aries_vcx` crate:
- `aries-vcx-agent` - aries agent library providing used to build our cross-framework testing [backchannel](https://github.com/hyperledger/aries-agent-test-harness/tree/main/aries-backchannels/aries-vcx)

3 changes: 0 additions & 3 deletions libvcx_core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,3 @@
This is foundational crate for
- NodeJS wrapper [`vcx-napi-rs`](../wrappers/vcx-napi-rs)

## Architecture

<img alt="Libvcx architecture diagram" src="../docs/architecture/architecture_230223_libvcx.png"/>

0 comments on commit dbaac13

Please sign in to comment.