Skip to content

Commit

Permalink
fix: updated readme details (#183)
Browse files Browse the repository at this point in the history
* fix: updated readme details

* fix: typo on description
  • Loading branch information
affrncsp authored Aug 13, 2024
1 parent 69b8651 commit 98d0cf3
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 17 deletions.
44 changes: 29 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,48 @@
[![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

The Affinidi Trust Development Kit (Affinidi TDK) is a modern interface that allows you to easily manage and integrate Affinidi services into your application. It minimises dependencies and enables developers seamless entry into the [Affinidi Trust Network (ATN)](https://www.affinidi.com/get-started).
The Affinidi Trust Development Kit (Affinidi TDK) is a modern interface that allows you to easily manage and integrate [Affinidi Elements]](https://www.affinidi.com/product/affinidi-elements) and [Frameworks](https://www.affinidi.com/developer#lota-framework) into your application. It minimises dependencies and enables developers seamless entry into the [Affinidi Trust Network (ATN)](https://www.affinidi.com/get-started).

## How do I use Affinidi TDK?

The Affinidi TDK provides three type of modules:

- [Clients](clients), which offer methods to access Affinidi services like IAM, Verifier, Wallets, and Login configuation, among others.
- [Clients](clients), which offer methods to access Affinidi Elements services like Credential Issuance, Credential Verification, and Login Configurations, among others.
- [Packages](packages), which are commonly used utilities/helpers that are self-contained and composable.
- [Libraries](libraries), which are high-level abstractions that combine logic and data to perform necessary business logic functionalities.

Each module has its own README that you can check to better understand how to integrate it into your application.

## Available modules

The Affinidi TDK offers the following modules and programming languages:
The Affinidi TDK offers the following modules and support to programming languages:



| | TypeScript | Python | Dart |
|----------- |-----------------------|-----------------------|----------------------|
|**Packages** | | | |
|[auth-provider](packages/auth-provider/) | 🟒 | 🟒 | πŸ”΄ |
|[common](packages/common/) | 🟒 | 🟒 | πŸ”΄ |
|**Packages** | | | |
|credential-issuance-client | [🟒 Link](clients/typescript/credential-issuance-client/) | [🟒 Link](clients/python/credential-issuance-client/) | [🟑 Link](clients/typescript/credential-issuance-client/) |
|credential-verification-client | [🟒 Link](clients/typescript/credential-verification-client/) | [🟒 Link](clients/typescript/credential-verification-client/) | [🟑 Link](clients/typescript/credential-verification-client/) |
|iam-client | [🟒 Link](clients/typescript/iam-client/) | [🟒 Link](clients/typescript/iam-client/) | [🟑 Link](clients/typescript/iam-client/) |
|iota-client | [🟒 Link](clients/typescript/iota-client/) | [🟒 Link](clients/typescript/iota-client/) | [🟑 Link](clients/typescript/iota-client/) |
|login-configuration-client | [🟒 Link](clients/typescript/login-configuration-client/) | [🟒 Link](clients/typescript/login-configuration-client/) | [🟑 Link](clients/typescript/login-configuration-client/) |
|wallets-client | [🟒 Link](clients/typescript/wallets-client/) | [🟒 Link](clients/typescript/wallets-client/) | [🟑 Link](clients/typescript/wallets-client/) |
|**Libraries** | | | |
|[iota-browser](libraries/iota-browser/) | 🟒 | πŸ”΄ | πŸ”΄ |
|[iota-core](libraries/iota-browser/) | 🟒 | 🟒 | πŸ”΄ |

<br />
🟒 Supported <br />
🟑 Experimental <br />
πŸ”΄ Not supported

| | Typescript | Python | Dart |
| ------------------------------------------------- | :------------------------------------------------: | :--------------------------------------------: | :------------------------------------------: |
| **Packages** |
| [auth-provider](packages/auth-provider/README.md) | 🟒 | 🟒 | πŸ”΄ |
| **Clients** |
| wallets-client | [🟒 Link](clients/typescript/wallets-client/README.md) | [🟒 Link](clients/python/wallets_client/README.md) | [🟑 Link](clients/dart/wallets-client/README.md) |
| iam-client | [🟒 Link](clients/typescript/iam-client/README.md) | [🟒 Link](clients/python/iam_client/README.md) | [🟑 Link](clients/dart/iam_client/README.md) |
| credential-verification-client | [🟒 Link](clients/typescript/credential-verification-client/README.md) | [🟒 Link](clients/python/credential_verification_client/README.md) | [🟑 Link](clients/dart/credential_verification_client/README.md) |
| login-configation | [🟒 Link](clients/typescript/login-configuration/README.md) | [🟒 Link](clients/python/login_configuration/README.md) | [🟑 Link](clients/dart/login_configuration/README.md) |
## Documentation

🟒 Supported<br>
🟑 Experimental<br>
πŸ”΄ Not supported
Head over to our [Documentation site](https://docs.affinidi.com/dev-tools/affinidi-tdk) to know how to get started with Affinidi TDK.

## Support & feedback

Expand Down
4 changes: 2 additions & 2 deletions libs/iota-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ npm install @affinidi-tdk/iota-core
run inside [python virtual env](https://docs.python.org/3/library/venv.html)

```bash
pip install affinidi_tdk_common
pip install affinidi_tdk_iota_core
```

## Usage

Head over to [Affinidi Iota Framework documentation](https://docs.affinidi.com/services/iota-framework) page to better understand how the service works.
Head over to [Affinidi Iota Framework documentation](https://docs.affinidi.com/frameworks/iota-framework) page to better understand how the service works.

For details on how to use this library please head over to [iota-core documentation](https://docs.affinidi.com/dev-tools/affinidi-tdk/libraries/iota-core) page.

0 comments on commit 98d0cf3

Please sign in to comment.