Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Additional guidance on the usage of the SDK.
  • Loading branch information
esplinr authored Oct 22, 2024
1 parent 76f4580 commit ff73d9a
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,16 @@
# `Dock` SDK monorepository
# `Dock` SDK

## Overview

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

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).

## Monorepository Packages

Features five packages, such as

Expand All @@ -16,4 +28,9 @@ In essence, the architecture is structured as follows:
- Specific implementations for the `Dock` and `Cheqd` blockchain modules can be found in `@docknetwork/dock-blockchain-modules`* and `@docknetwork/cheqd-blockchain-modules`, respectively.
- Basic blockchain connectors for the `Dock` and `Cheqd` blockchain are available through `@docknetwork/dock-blockchain-api`* and `@docknetwork/cheqd-blockchain-api`.

## Deprecated Features

* 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

0 comments on commit ff73d9a

Please sign in to comment.