Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@leonardocustodio
leonardocustodio authored Jan 30, 2024
1 parent dea0b71 commit 40ced58
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,17 @@ This library is funded by [Web3 Foundation](https://web3.foundation) via their [

This repo is a monorepo for `polkadart` and related pkgs.

| Pub | Package | Description |
|----------------------------------------------------------------------------|---------------------------------------------------------------------|-----------------------------------------|
| [![version][pkg:polkadart:version]][pkg:polkadart] | [`package:polkadart`][pkg:polkadart:source] | The core package that provides tools to connect and interact with the Polkadot or Substrate chains. It abstracts the complexities of the network protocols and offers straightforward APIs. |
| [![version][pkg:polkadart_cli:version]][pkg:polkadart_cli] | [`package:polkadart_cli`][pkg:polkadart_cli:source] | A command-line interface tool that generates dart language types and corresponding definitions by interpreting the chain's metadata. |
| [![version][pkg:polkadart_keyring:version]][pkg:polkadart_keyring] | [`package:polkadart_keyring`][pkg:polkadart_keyring:source] | Manages keys and addresses for Polkadot/Substrate accounts. Contains cryptographic functions related to creating keys, signing transactions, and managing user identities on the blockchain. |
| [![version][pkg:polkadart_scale_codec:version]][pkg:polkadart_scale_codec] | [`package:polkadart_scale_codec`][pkg:polkadart_scale_codec:source] | SCALE (Simple Concatenated Aggregate Little-Endian) is a codec used by Substrate to efficiently encode and decode data. Contains a dart implementation of this codec. |
| [![version][pkg:secp256k1_ecdsa:version]][pkg:secp256k1_ecdsa] | [`package:secp256k1_ecdsa`][pkg:secp256k1_ecdsa:source] | Implementation of the SECP256k1 elliptic curve used in the ECDSA (Elliptic Curve Digital Signature Algorithm) for cryptographic operations, which is widely used in various blockchain platforms. |
| [![version][pkg:sr25519:version]][pkg:sr25519] | [`package:sr25519`][pkg:sr25519:source] | Implementation of Schnorrkel-based signature scheme used in Substrate. Contains functionalities related to this scheme, such as key generation and signing. |
| [![version][pkg:ss58:version]][pkg:ss58] | [`package:ss58`][pkg:ss58:source] | SS58 is a cryptocurrency address format used by Substrate. This package includes utilities to encode and decode these addresses. |
| [![version][pkg:substrate_bip39:version]][pkg:substrate_bip39] | [`package:substrate_bip39`][pkg:substrate_bip39:source] | BIP39 (Bitcoin Improvement Proposal 39) pertains to the generation of mnemonic phrases for cryptographic keys. Creates human-readable phrases that map to the keys used on Substrate-based chains. |
| [![version][pkg:substrate_metadata:version]][pkg:substrate_metadata] | [`package:substrate_metadata`][pkg:substrate_metadata:source] | Provides the necessary tools to decode the metadata provided by a Substrate blockchain node. And can be used to easily decode constants, extrinsics, events, and other data written in the chain. |
| Package | Description |
|----------------------------------------------------------------------------|-----------------------------------------|
| [![version][pkg:polkadart:version]][pkg:polkadart] | The core package that provides tools to connect and interact with the Polkadot or Substrate chains. It abstracts the complexities of the network protocols and offers straightforward APIs. |
| [![version][pkg:polkadart_cli:version]][pkg:polkadart_cli] | A command-line interface tool that generates dart language types and corresponding definitions by interpreting the chain's metadata. |
| [![version][pkg:polkadart_keyring:version]][pkg:polkadart_keyring] | Manages keys and addresses for Polkadot/Substrate accounts. Contains cryptographic functions related to creating keys, signing transactions, and managing user identities on the blockchain. |
| [![version][pkg:polkadart_scale_codec:version]][pkg:polkadart_scale_codec] | SCALE (Simple Concatenated Aggregate Little-Endian) is a codec used by Substrate to efficiently encode and decode data. Contains a dart implementation of this codec. |
| [![version][pkg:secp256k1_ecdsa:version]][pkg:secp256k1_ecdsa] | Implementation of the SECP256k1 elliptic curve used in the ECDSA (Elliptic Curve Digital Signature Algorithm) for cryptographic operations, which is widely used in various blockchain platforms. |
| [![version][pkg:sr25519:version]][pkg:sr25519] | Implementation of Schnorrkel-based signature scheme used in Substrate. Contains functionalities related to this scheme, such as key generation and signing. |
| [![version][pkg:ss58:version]][pkg:ss58] | SS58 is a cryptocurrency address format used by Substrate. This package includes utilities to encode and decode these addresses. |
| [![version][pkg:substrate_bip39:version]][pkg:substrate_bip39] | BIP39 (Bitcoin Improvement Proposal 39) pertains to the generation of mnemonic phrases for cryptographic keys. Creates human-readable phrases that map to the keys used on Substrate-based chains. |
| [![version][pkg:substrate_metadata:version]][pkg:substrate_metadata] | Provides the necessary tools to decode the metadata provided by a Substrate blockchain node. And can be used to easily decode constants, extrinsics, events, and other data written in the chain. |

## Documentation and Tests

Expand All @@ -43,38 +43,38 @@ Or if you have [Melos](https://melos.invertase.dev/~melos-latest/getting-started

This repository is licensed under [Apache 2.0 license](https://github.com/leonardocustodio/polkadart/blob/main/LICENSE)

[pkg:polkadart]: https://pub.dartlang.org/pkgs/polkadart
[pkg:polkadart]: https://pub.dartlang.org/packages/polkadart
[pkg:polkadart:version]: https://img.shields.io/pub/v/polkadart.svg
[pkg:polkadart:source]: ./packages/polkadart

[pkg:polkadart_cli]: https://pub.dartlang.org/pkgs/polkadart_cli
[pkg:polkadart_cli]: https://pub.dartlang.org/packages/polkadart_cli
[pkg:polkadart_cli:version]: https://img.shields.io/pub/v/polkadart_cli.svg
[pkg:polkadart_cli:source]: ./packages/polkadart_cli

[pkg:polkadart_keyring]: https://pub.dartlang.org/pkgs/polkadart_keyring
[pkg:polkadart_keyring]: https://pub.dartlang.org/packages/polkadart_keyring
[pkg:polkadart_keyring:version]: https://img.shields.io/pub/v/polkadart_keyring.svg
[pkg:polkadart_keyring:source]: ./packages/polkadart_keyring

[pkg:polkadart_scale_codec]: https://pub.dartlang.org/pkgs/polkadart_scale_codec
[pkg:polkadart_scale_codec]: https://pub.dartlang.org/packages/polkadart_scale_codec
[pkg:polkadart_scale_codec:version]: https://img.shields.io/pub/v/polkadart_scale_codec.svg
[pkg:polkadart_scale_codec:source]: ./packages/polkadart_scale_codec

[pkg:secp256k1_ecdsa]: https://pub.dartlang.org/pkgs/secp256k1_ecdsa
[pkg:secp256k1_ecdsa]: https://pub.dartlang.org/packages/secp256k1_ecdsa
[pkg:secp256k1_ecdsa:version]: https://img.shields.io/pub/v/secp256k1_ecdsa.svg
[pkg:secp256k1_ecdsa:source]: ./packages/secp256k1_ecdsa

[pkg:sr25519]: https://pub.dartlang.org/pkgs/sr25519
[pkg:sr25519]: https://pub.dartlang.org/packages/sr25519
[pkg:sr25519:version]: https://img.shields.io/pub/v/sr25519.svg
[pkg:sr25519:source]: ./packages/sr25519

[pkg:ss58]: https://pub.dartlang.org/pkgs/ss58
[pkg:ss58]: https://pub.dartlang.org/packages/ss58
[pkg:ss58:version]: https://img.shields.io/pub/v/ss58.svg
[pkg:ss58:source]: ./packages/ss58

[pkg:substrate_bip39]: https://pub.dartlang.org/pkgs/substrate_bip39
[pkg:substrate_bip39]: https://pub.dartlang.org/packages/substrate_bip39
[pkg:substrate_bip39:version]: https://img.shields.io/pub/v/substrate_bip39.svg
[pkg:substrate_bip39:source]: ./packages/substrate_bip39

[pkg:substrate_metadata]: https://pub.dartlang.org/pkgs/substrate_metadata
[pkg:substrate_metadata]: https://pub.dartlang.org/packages/substrate_metadata
[pkg:substrate_metadata:version]: https://img.shields.io/pub/v/substrate_metadata.svg
[pkg:substrate_metadata:source]: ./packages/substrate_metadata

0 comments on commit 40ced58

Please sign in to comment.