Skip to content

Latest commit

 

History

History
204 lines (185 loc) · 7.77 KB

README.md

File metadata and controls

204 lines (185 loc) · 7.77 KB
Raw


Credo Logo

Credo

Pipeline Status Codecov Coverage License typescript


Features  |  Getting started  |  Contributing  |  License

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.

Note The Aries Framework JavaScript project has recently been rebranded to "Credo" and was moved from the Hyperledger Foundation to the Open Wallet Foundation. 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. 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 we will update this README and all the documentation to reflect this change. You can follow this discussion for updates about the name: openwallet-foundation#1668

Features

See Supported Features on the Credo website for a full list of supported features.

  • 🏃 Runs in React Native & Node.JS
  • 🔒 DIDComm v1 support
  • 🌎 Aries Interop Profile v1 & v2 support
    • With support for Chat, Mediator Coordination, Indy Credentials & and JSON-LD Credentials sub-targets
  • did:web, did:key, did:jwk, did:peer, did:sov, did:indy and did:cheqd, with pluggable interface for registering custom did methods.
  • OpenID for Verifiable Credentials
  • W3C Verifiable Credentials, SD-JWT VCs and AnonCreds
  • 💡 Smart Auto Acceptance of Connections, Credentials and Proofs
  • 🏢 Multi tenant module for managing multiple tenants under a single agent.

Packages

Package Version
@credo-ts/core @credo-ts/core version
@credo-ts/node @credo-ts/node version
@credo-ts/react-native @credo-ts/react-native version
@credo-ts/indy-vdr @credo-ts/indy-vdr version
@credo-ts/cheqd @credo-ts/cheqd version
@credo-ts/askar @credo-ts/askar version
@credo-ts/anoncreds @credo-ts/anoncreds version
@credo-ts/openid4vc @credo-ts/openid4vc version
@credo-ts/action-menu @credo-ts/action-menu version
@credo-ts/question-answer @credo-ts/question-answer version
@credo-ts/tenants @credo-ts/tenants version
@aries-framework/indy-sdk (deprecated, unmaintained after 0.4.x) @aries-framework/indy-sdk version
@aries-framework/anoncreds-rs (deprecated and combined with @credo-ts/anoncreds) @aries-framework/anoncreds-rs version
@credo-ts/openid4vc-client (deprecated in favour of @credo-ts/openid4vc) @credo-ts/openid4vc-client version

Getting Started

Documentation on how to get started with Credo can be found at https://credo.js.org/

Demo

To get to know the Credo flow, we built a demo to walk through it yourself together with agents Alice and Faber.

You can run the demo in the /demo directory of this repository.

Contributing

If you would like to contribute to the framework, please read the Framework Developers README and the CONTRIBUTING guidelines. These documents will provide more information to get you started!

There are regular community working groups to discuss ongoing efforts within the framework, showcase items you've built with Credo, or ask questions. See Meeting Information for up to date information on the meeting schedule. Everyone is welcome to join!

We welcome you to join our mailing list and Discord channel. See the Wiki for up to date information.

License

OpenWallet Foundation Credo is licensed under the Apache License Version 2.0 (Apache-2.0).