Skip to content

Commit 16eb09b

Browse files
tweeddalexgitbook-bot
authored andcommitted
GITBOOK-380: change request with no subject merged in GitBook
1 parent cbb26a1 commit 16eb09b

File tree

4 files changed

+22
-22
lines changed

4 files changed

+22
-22
lines changed

sdk/credo/README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Credo with cheqd support
44

55
# 🍏 Credo
66

7-
### Get Started with Credo
7+
## Get Started with Credo
88

99
**Credo** is a TypeScript-based framework for building Self-Sovereign Identity (SSI) agents and services. It is designed for **modularity**, **interoperability**, and **compliance** with the European Architecture and Reference Framework (ARF).
1010

@@ -40,13 +40,9 @@ This includes:
4040
* Support for the **cheqd AnonCreds Object Method**
4141
* Native DID and resource support for `did:cheqd`
4242

43-
## Architecture
44-
45-
<figure><img src="../../.gitbook/assets/afj packages diagram.png" alt=""><figcaption><p>Aries Framework JavaScript packages diagram</p></figcaption></figure>
46-
4743
## Get started
4844

49-
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>cheqd Agent Setup</strong></mark></td><td>Setup the cheqd agent to start being able to use cheqd inside Credo.</td><td><a href="setup-credo-agent.md">setup-credo-agent.md</a></td></tr><tr><td><mark style="color:blue;"><strong>Create cheqd DIDs</strong></mark></td><td>Use the cheqd DID module to start being able to create cheqd DIDs.</td><td><a href="decentralized-identifiers-dids/create-a-did.md">create-a-did.md</a></td></tr><tr><td><mark style="color:blue;"><strong>Issue a Credential</strong></mark></td><td>Issue a digital Credential using a cheqd DID.</td><td><a href="verifiable-credentials-and-presentations/issue-a-verifiable-credential.md">issue-a-verifiable-credential.md</a></td></tr></tbody></table>
45+
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>cheqd Agent Setup</strong></mark></td><td>Setup the cheqd agent to start being able to use cheqd inside Credo.</td><td><a href="setup-credo-agent.md">setup-credo-agent.md</a></td></tr><tr><td><mark style="color:blue;"><strong>Create cheqd DIDs</strong></mark></td><td>Use the cheqd DID module to start being able to create cheqd DIDs.</td><td><a href="decentralized-identifiers-dids/create-a-did.md">create-a-did.md</a></td></tr><tr><td><mark style="color:blue;"><strong>Issue a Credential</strong></mark></td><td>Issue a Verifiable Credential using a cheqd DID.</td><td><a href="verifiable-credentials-and-presentations/issue-a-verifiable-credential.md">issue-a-verifiable-credential.md</a></td></tr></tbody></table>
5046

5147

5248

sdk/credo/verifiable-credentials-and-presentations/issue-a-verifiable-credential.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: Issue AnonCreds with did:cheqd.
2+
description: Issue a Verifiable Credential (AnonCreds) with did:cheqd.
33
---
44

55
# Issue a Verifiable Credential (AnonCreds)
@@ -8,14 +8,14 @@ Using **AnonCreds** and the **Issue Credential v2 Protocol**, you can issue Veri
88

99
Before you begin, make sure you have:
1010

11-
* A **registered `did:cheqd` identifier** for the Issuer
12-
* A **Credential Schema** and **Credential Definition** already created and published as DID-Linked Resources
13-
* A Credo Agent configured with:
11+
* A **registered `did:cheqd` identifier** for the Issuer
12+
* A **Credential Schema** and **Credential Definition** already created and published as DID-Linked Resources
13+
* A Credo Agent configured with:
1414
* `@credo-ts/cheqd` for DID operations and resource publishing
1515
* `@credo-ts/anoncreds` for AnonCreds credential handling
1616
* `@credo-ts/didcomm` for DIDComm messaging
17-
* Two agents: an **Issuer** and a **Holder** (can be separate apps or run locally)
18-
* Secure connectivity between agents using **Out-of-Band (OOB)** or a supported connection method
17+
* Two agents: an **Issuer** and a **Holder** (can be separate apps or run locally)
18+
* Secure connectivity between agents using **Out-of-Band (OOB)** or a supported connection method
1919

2020
## Step 1: Create a Connection with Holder
2121

sdk/credo/verifiable-credentials-and-presentations/present-a-verifiable-credential.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: Present a Verifiable Credential using Credo
3+
---
4+
15
# Present a Verifiable Credential (AnonCreds)
26

37
Verifiable Credentials signed by a `did:cheqd` can be securely presented using the **AnonCreds proof format** and the **Present Proof Protocol v2** within the Credo framework. This enables trust-minimised, selective disclosure of credential data between a **Holder** and a **Verifier**.
@@ -6,10 +10,10 @@ Verifiable Credentials signed by a `did:cheqd` can be securely presented using t
610

711
Before presenting a credential:
812

9-
* A **Verifiable Credential** must have been issued and accepted by the Holder
10-
* A **Credo Agent** is running for both the Verifier and the Holder
11-
* A **DIDComm connection** exists between Holder and Verifier (via OOB or another method)
12-
* Both agents are configured with:
13+
* A **Verifiable Credential** must have been issued and accepted by the Holder
14+
* A **Credo Agent** is running for both the Verifier and the Holder
15+
* A **DIDComm connection** exists between Holder and Verifier (via OOB or another method)
16+
* Both agents are configured with:
1317
* `@credo-ts/anoncreds`
1418
* `@credo-ts/didcomm`
1519

sdk/veramo-plugin/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: Veramo SDK plugin for cheqd identity functionality
88

99
[Veramo SDK](https://veramo.io/) is a modular and pluggable client app SDK for decentralised identity and SSI applications. Our Veramo plugin - the [`@cheqd/did-provider-cheqd` NPM package](https://www.npmjs.com/package/@cheqd/did-provider-cheqd) - enables developers to interact with the cheqd ledger using Veramo SDK.
1010

11-
This package includes [Veramo SDK Agent methods](https://veramo.io/docs/veramo\_agent/plugins) for use with the [Veramo CLI NPM package](https://www.npmjs.com/package/@veramo/cli). It can also be consumed as an NPM package outside Veramo CLI for building your own applications with NPM.
11+
This package includes [Veramo SDK Agent methods](https://veramo.io/docs/veramo_agent/plugins) for use with the [Veramo CLI NPM package](https://www.npmjs.com/package/@veramo/cli). It can also be consumed as an NPM package outside Veramo CLI for building your own applications with NPM.
1212

1313
The package's core functionality is borrowed from [Veramo Core NPM package](https://www.npmjs.com/package/@veramo/core) and extends this to include cheqd ledger functionality, such as creating and managing DIDs.
1414

@@ -34,7 +34,7 @@ Veramo provides an excellent foundation for clients that want to build verifiabl
3434

3535
Using the DID-Provider-cheqd package, we have also been able to **reuse identity functionality** and abstract the complexity of cheqd/SDK and cheqd Network in less complex packages.
3636

37-
### `did:cheqd`-specific functionality
37+
### did:cheqd-specific functionality
3838

3939
`did-provider-cheqd` is the first Veramo SDK plug-in that utilises the _DID Manager Update_ method to offer a full-body DIDDoc update for a DID on cheqd ledger, rather than individual field update transactions used more commonly in other DID methods such as [`did:ethr`](https://developer.uport.me/ethr-did/docs/index).
4040

@@ -62,7 +62,7 @@ The `@cheqd/sdk` package adds Cosmos SDK specific functionality such as signing
6262

6363
For identity-related keys, this plugin uses [Veramo's Key Management System (KMS)](https://www.npmjs.com/package/@veramo/key-manager) to manage keys for create and update operations.
6464

65-
Find out about [other Veramo plug-ins in their official documentation](https://veramo.io/docs/veramo\_agent/plugins/).
65+
Find out about [other Veramo plug-ins in their official documentation](https://veramo.io/docs/veramo_agent/plugins/).
6666

6767
## Supported Credential types
6868

@@ -80,6 +80,6 @@ Depending on the type of application you are looking to develop, you will need t
8080

8181
For other applications, see:
8282

83-
* [Veramo Node.js tutorial](https://veramo.io/docs/node\_tutorials/node\_setup\_identifiers)
84-
* [Veramo React tutorial](https://veramo.io/docs/react\_tutorials/react\_setup\_resolver)
85-
* [Veramo React Native tutorial](https://veramo.io/docs/react\_native\_tutorials/react\_native\_1\_setup\_identifiers)
83+
* [Veramo Node.js tutorial](https://veramo.io/docs/node_tutorials/node_setup_identifiers)
84+
* [Veramo React tutorial](https://veramo.io/docs/react_tutorials/react_setup_resolver)
85+
* [Veramo React Native tutorial](https://veramo.io/docs/react_native_tutorials/react_native_1_setup_identifiers)

0 commit comments

Comments
 (0)