diff --git a/README.md b/README.md index a630cace9..87f5eb1fa 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,17 @@ The Dock SDK is an opensource library that powers Dock's SaaS API. It provides the credential management, cryptography, and blockchain storage features for Dock's supported credential variants: -* W3C VC JSON-LD ed25519 credential using StatusList 2021 for revocation targetted at interoperability -* W3C VC JSON-LD BBS credential using accumulators for revocation targetted at privacy -* W3C VC JSON-LD KVAC credential using accumulators for revocation allowing monetization of credentials +* W3C-VC JWT credentials +* W3C-VC JSON-LD ed25519 credentials using StatusList 2021 +* W3C-VC JSON-LD BBS2023 credentials using accumulators for revocation +* W3C-VC JSON-LD BBDT16 credentials using accumulators for revocation -Most of the SDK is written in JavaScript / TypeScript with safety-critical code written in Rust. The SDK depends on [the Arkworks math library](https://github.com/arkworks-rs/algebra). +This JavaScript SDK depends on: +* The [Dock Rust Crypto Library](https://github.com/docknetwork/crypto) +* The [TypeScript wrapper to the Dock Crypto Library](https://github.com/docknetwork/crypto-wasm-ts) +* [The Arkworks math library](https://github.com/arkworks-rs/algebra) + +You are welcome to explore the [tutorials](./tutorials) and [examples](./examples) to get a basic understanding. ## Monorepository Packages @@ -18,8 +24,6 @@ Features four packages, such as - [`@docknetwork/cheqd-blockchain-api`](./packages/cheqd-blockchain-api) - A Javascript library built atop of `@cheqd/sdk` that allows to interact with the `Cheqd` blockchain. - [`@docknetwork/cheqd-blockchain-modules`](./packages/cheqd-blockchain-modules) - A JavaScript library created for managing credential SDK components such as DIDs, accumulators etc on the Cheqd blockchain. -You are welcome to explore the [tutorials](./tutorials) and [examples](./examples) to get a basic understanding. - In essence, the architecture is structured as follows: - The fundamentals of VC, including types, cryptography, and abstract modules, are housed in `@docknetwork/credential-sdk`. @@ -31,4 +35,5 @@ In essence, the architecture is structured as follows: * Dock blockchain will be sunset in 2025. [More information.](https://www.dock.io/post/dock-and-cheqd-form-alliance-to-accelerate-global-adoption-of-decentralized-id#stronglong-termstrong) Some features of the SDK are deprecated and will be removed in a future release: -* StatusList2017 +* Revocation registries based on StatusList2017 +* [Anchoring content to the chain](./examples/anchor.js)