Skip to content

Commit 5919833

Browse files
authored
chore: update readme (openwallet-foundation#1918)
1 parent 808f64a commit 5919833

File tree

1 file changed

+23
-24
lines changed

1 file changed

+23
-24
lines changed

README.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -32,34 +32,28 @@
3232
<br />
3333

3434
<p align="center">
35+
<a href="#quickstart">Quickstart</a> &nbsp;|&nbsp;
3536
<a href="#features">Features</a> &nbsp;|&nbsp;
36-
<a href="#getting-started">Getting started</a> &nbsp;|&nbsp;
3737
<a href="#contributing">Contributing</a> &nbsp;|&nbsp;
3838
<a href="#license">License</a>
3939
</p>
4040

41-
Credo is a framework written in TypeScript for building **SSI Agents and DIDComm services** that aims to be **compliant and interoperable** with the standards defined in the [Aries RFCs](https://github.com/hyperledger/aries-rfcs).
41+
Credo is a framework written in TypeScript for building **decentralized identity solutions** that aims to be compliant and **interoperable with identity standards across the world**. Credo is agnostic to any specific exchange protocol, credential format, signature suite or did method, but currently mainly focuses on alignment with [OpenID4VC](https://openid.net/sg/openid4vc/), [DIDComm](https://identity.foundation/didcomm-messaging/spec/) and [Hyperledger Aries](https://hyperledger.github.io/aries-rfcs/latest/).
4242

43-
> **Note**
44-
> The Aries Framework JavaScript project has recently been rebranded to "Credo" and was moved from the Hyperledger Foundation to the Open Wallet Foundation.
45-
> We are currently in the process of changing the name of the project to Credo, and updating all the documentation and links to reflect this change.
46-
> You may encounter some broken links, or references to the old name, but we are working hard to fix this. Once the new name has been decided
47-
> we will update this README and all the documentation to reflect this change.
48-
> You can follow this discussion for updates about the name: https://github.com/openwallet-foundation/agent-framework-javascript/discussions/1668
43+
## Quickstart
44+
45+
Documentation on how to get started with Credo can be found at https://credo.js.org/
4946

5047
## Features
5148

5249
See [Supported Features](https://credo.js.org/guides/features) on the Credo website for a full list of supported features.
5350

54-
- 🏃 Runs in React Native & Node.JS
55-
- 🔒 DIDComm v1 support
56-
- 🌎 [Aries Interop Profile](https://github.com/hyperledger/aries-rfcs/blob/main/concepts/0302-aries-interop-profile/README.md) v1 & v2 support
57-
- With support for Chat, Mediator Coordination, Indy Credentials & and JSON-LD Credentials sub-targets
58-
- `did:web`, `did:key`, `did:jwk`, `did:peer`, `did:sov`, `did:indy` and `did:cheqd`, with pluggable interface for registering custom did methods.
59-
- OpenID for Verifiable Credentials
60-
- W3C Verifiable Credentials, SD-JWT VCs and AnonCreds
61-
- 💡 Smart Auto Acceptance of Connections, Credentials and Proofs
62-
- 🏢 Multi tenant module for managing multiple tenants under a single agent.
51+
- 🏃 **Platform agnostic** - out of the box support for Node.JS and React Native
52+
- 🔒 **DIDComm and AIP** - Support for [DIDComm v1](https://hyperledger.github.io/aries-rfcs/latest/concepts/0005-didcomm/), and both v1 and v2 of the [Aries Interop Profile](https://github.com/hyperledger/aries-rfcs/blob/main/concepts/0302-aries-interop-profile/README.md).
53+
- 🛂 **Extendable [DID](https://www.w3.org/TR/did-core/) resolver and registrar** - out of the box support for `did:web`, `did:key`, `did:jwk`, `did:peer`, `did:sov`, `did:indy` and `did:cheqd`.
54+
- 🔑 **[OpenID4VC](https://openid.net/sg/openid4vc/)** - support for [OpenID for Verifiable Credential Issuance](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html), [OpenID for Verifiable Presentations](https://openid.net/specs/openid-4-verifiable-presentations-1_0.html) and [Self-Issued OpenID Provider v2](https://openid.net/specs/openid-connect-self-issued-v2-1_0.html).
55+
- 🪪 **Multiple credential formats** - [W3C Verifiable Credential Data Model v1.1](https://www.w3.org/TR/vc-data-model/), [SD-JWT VCs](https://www.ietf.org/archive/id/draft-ietf-oauth-sd-jwt-vc-03.html), and [AnonCreds](https://hyperledger.github.io/anoncreds-spec/).
56+
- 🏢 **Multi-tenant** - Optional multi-tenant module for managing multiple tenants under a single agent.
6357

6458
### Packages
6559

@@ -155,6 +149,14 @@ See [Supported Features](https://credo.js.org/guides/features) on the Credo webs
155149
</a>
156150
</td>
157151
</tr>
152+
<tr>
153+
<td>@credo-ts/drpc</td>
154+
<td>
155+
<a href="https://npmjs.com/package/@credo-ts/drpc">
156+
<img alt="@credo-ts/drpc version" src="https://img.shields.io/npm/v/@credo-ts/drpc"/>
157+
</a>
158+
</td>
159+
</tr>
158160
<tr>
159161
<td><s>@aries-framework/indy-sdk</s> (deprecated, unmaintained after 0.4.x)</td>
160162
<td>
@@ -181,15 +183,12 @@ See [Supported Features](https://credo.js.org/guides/features) on the Credo webs
181183
</tr>
182184
</table>
183185

184-
## Getting Started
185-
186-
Documentation on how to get started with Credo can be found at https://credo.js.org/
187-
188-
### Demo
186+
## Demo
189187

190-
To get to know the Credo flow, we built a demo to walk through it yourself together with agents Alice and Faber.
188+
To get to know the Credo issuance and verification flow, we built a demo to walk through it yourself together with agents Alice and Faber.
191189

192-
You can run the demo in the [`/demo`](/demo) directory of this repository.
190+
- OpenID4VC and SD-JWT VC demo in the [`/demo-openid`](/demo-openid) directory.
191+
- DIDComm and AnonCreds demo in the [`/demo`](/demo) directory.
193192

194193
## Contributing
195194

0 commit comments

Comments
 (0)