Skip to content

Commit 62a8dca

Browse files
authored
Update README.md
added the Overview section - please review content and edit if I have misstated anything Signed-off-by: Diane Mueller <[email protected]>
1 parent f0f72b5 commit 62a8dca

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,21 @@ This library is using [Hiero Python SDK](https://github.com/hiero-ledger/hiero-s
1616
2. [Getting started](#getting-started)
1717
3. [Configuration](#configuration)
1818
4. [Contributing](CONTRIBUTING.md)
19+
20+
## Overview
21+
22+
Identity networks are set of artifacts on Hedera Consensus Service that allow applications to share common channels to publish and resolve DID documents, issue verifiable credentials and control their validity status. These artifacts include:
23+
* address book - a file on Hedera File Service that provides information about HCS topics and appnet servers,
24+
* DID topic - an HCS topic intended for publishing DID documents,
25+
* and VC topic - an HCS topic playing a role of verifiable credentials registry.
26+
27+
This SDK is designed to simplify :
28+
* creation of identity networks within appnets, that is: creation and initialization of the artifacts mentioned above,
29+
* generation of decentralized identifiers for Hedera DID Method and creation of their basic DID documents,
30+
* creation (publishing), update, deletion and resolution of DID documents in appnet identity networks,
31+
* issuance, revocation and status verification of Verifiable Credentials.
32+
33+
The SDK does not impose any particular way of how the DID or verifiable credential documents are constructed.
1934

2035
## Documentation
2136

0 commit comments

Comments
 (0)