Skip to content

Commit 795b32a

Browse files
meherettmeherett
committed
Update: docs/index.rst and README.md
1 parent 719618c commit 795b32a

2 files changed

Lines changed: 19 additions & 21 deletions

File tree

‎README.md‎

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,21 @@
99

1010
Python-based library implementing a Hierarchical Deterministic (HD) Wallet generator for 200+ cryptocurrencies.
1111

12-
> The library is designed to be flexible and scalable, making it ideal for developers who need to integrate multi-currency wallet functionalities into their applications.
13-
> It supports standard protocols for compatibility with other wallets and services, offering features like secure seed creation, efficient key management, and easy account handling.
14-
>
15-
> This library simplifies the complexity of blockchain interactions and enhances security for end-users.
16-
17-
| Features | Protocols |
18-
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
19-
| Cryptocurrencies | <a href="https://hdwallet.io/cryptocurrencies">#supported-cryptocurrencies</a> |
20-
| Entropies | ``Algorand``, ``BIP39``, ``Electrum-V1``, ``Electrum-V2``, ``Monero`` |
21-
| Mnemonics | ``Algorand``, ``BIP39``, ``Electrum-V1``, ``Electrum-V2``, ``Monero`` |
22-
| Seeds | ``Algorand``, ``BIP39``, ``Cardano``, ``Electrum-V1``, ``Electrum-V2``, ``Monero`` |
23-
| Elliptic Curve Cryptography's | ``Kholaw-Ed25519``, ``SLIP10-Ed25519``, ``SLIP10-Ed25519-Blake2b``, ``SLIP10-Ed25519-Monero``, ``SLIP10-Nist256p1``, ``SLIP10-Secp256k1`` |
24-
| Hierarchical Deterministic's | ``BIP32``, ``BIP44``, ``BIP49``, ``BIP84``, ``BIP86``, ``BIP141``, ``Cardano``, ``Electrum-V1``, ``Electrum-V2``, ``Monero`` |
25-
| Derivations | ``BIP44``, ``BIP49``, ``BIP84``, ``BIP86``, ``CIP1852``, ``Custom``, ``Electrum``, ``Monero``, ``HDW (Our own custom derivation)`` |
26-
| Addresses | ``Algorand``, ``Aptos``, ``Avalanche``, ``Cardano``, ``Cosmos``, ``EOS``, ``Ergo``, ``Ethereum``, ``Filecoin``, ``Harmony``, ``Icon``, ``Injective``, ``Monero``, ``MultiversX``, ``Nano``, ``Near``, ``Neo``, ``OKT-Chain``, ``P2PKH``, ``P2SH``, ``P2TR``, ``P2WPKH``, ``P2WPKH-In-P2SH``, ``P2WSH``, ``P2WSH-In-P2SH``, ``Ripple``, ``Solana``, ``Stellar``, ``Sui``, ``Tezos``, ``Tron``, ``XinFin``, ``Zilliqa`` |
27-
| Others | ``BIP38``, ``Wallet Import Format``, ``Serialization`` |
12+
> This library offers a flexible and scalable solution for developers integrating multi-currency wallet functionality. It adheres to standard protocols for compatibility with other wallets and services, and provides features like secure seed generation, robust key management, and streamlined account control. By simplifying blockchain interactions, it enhances the developer experience and strengthens end-user security.
13+
>
14+
> For JavaScript/TypeScript support, explore [hdwallet.js](https://github.com/hdwallet-io/hdwallet.js), the official port of this library. Try it live at https://hdwallet.online, our interactive web playground.
15+
16+
| Features | Protocols |
17+
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
18+
| Cryptocurrencies | <a href="https://hdwallet.io/cryptocurrencies">#supported-cryptocurrencies</a> |
19+
| Entropies | `Algorand`, `BIP39`, `Electrum-V1`, `Electrum-V2`, `Monero` |
20+
| Mnemonics | `Algorand`, `BIP39`, `Electrum-V1`, `Electrum-V2`, `Monero` |
21+
| Seeds | `Algorand`, `BIP39`, `Cardano`, `Electrum-V1`, `Electrum-V2`, `Monero` |
22+
| Elliptic Curve Cryptography's | `Kholaw-Ed25519`, `SLIP10-Ed25519`, `SLIP10-Ed25519-Blake2b`, `SLIP10-Ed25519-Monero`, `SLIP10-Nist256p1`, `SLIP10-Secp256k1` |
23+
| Hierarchical Deterministic's | `BIP32`, `BIP44`, `BIP49`, `BIP84`, `BIP86`, `BIP141`, `Cardano`, `Electrum-V1`, `Electrum-V2`, `Monero` |
24+
| Derivations | `BIP44`, `BIP49`, `BIP84`, `BIP86`, `CIP1852`, `Custom`, `Electrum`, `Monero`, `HDW (Our own custom derivation)` |
25+
| Addresses | `Algorand`, `Aptos`, `Avalanche`, `Cardano`, `Cosmos`, `EOS`, `Ergo`, `Ethereum`, `Filecoin`, `Harmony`, `Icon`, `Injective`, `Monero`, `MultiversX`, `Nano`, `Near`, `Neo`, `OKT-Chain`, `P2PKH`, `P2SH`, `P2TR`, `P2WPKH`, `P2WPKH-In-P2SH`, `P2WSH`, `P2WSH-In-P2SH`, `Ripple`, `Solana`, `Stellar`, `Sui`, `Tezos`, `Tron`, `XinFin`, `Zilliqa` |
26+
| Others | `BIP38`, `Wallet Import Format`, `Serialization` |
2827

2928
## Installation
3029

@@ -183,7 +182,7 @@ Explore more [Examples](https://github.com/hdwallet-io/python-hdwallet/blob/mast
183182

184183
### Command Line Interface (CLI)
185184

186-
The ``hdwallet`` CLI provides a simple way to generate wallets, derive addresses, and manage keys directly from your terminal, with options for exporting data in JSON and CSV formats.
185+
The `hdwallet` CLI provides a simple way to generate wallets, derive addresses, and manage keys directly from your terminal, with options for exporting data in JSON and CSV formats.
187186

188187
![HDWallet-CLI](https://raw.githubusercontent.com/hdwallet-io/python-hdwallet/refs/heads/master/docs/static/svg/hdwallet-cli.svg)
189188

@@ -459,4 +458,4 @@ If this tool was helpful, support its development with a donation or a ⭐!
459458
460459
## License
461460

462-
Distributed under the [MIT](https://github.com/hdwallet-io/python-hdwallet/blob/master/LICENSE) license. See ``LICENSE`` for more information.
461+
Distributed under the [MIT](https://github.com/hdwallet-io/python-hdwallet/blob/master/LICENSE) license. See `LICENSE` for more information.

‎docs/index.rst‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,9 @@ Python-based library implementing a Hierarchical Deterministic (HD) Wallet gener
2626

2727
.. epigraph::
2828

29-
The library is designed to be flexible and scalable, making it ideal for developers who need to integrate multi-currency wallet functionalities into their applications.
30-
It supports standard protocols for compatibility with other wallets and services, offering features like secure seed creation, efficient key management, and easy account handling.
29+
This library offers a flexible and scalable solution for developers integrating multi-currency wallet functionality. It adheres to standard protocols for compatibility with other wallets and services, and provides features like secure seed generation, robust key management, and streamlined account control. By simplifying blockchain interactions, it enhances the developer experience and strengthens end-user security.
3130

32-
This library simplifies the complexity of blockchain interactions and enhances security for end-users.
31+
For JavaScript/TypeScript support, explore `hdwallet.js <https://github.com/hdwallet-io/hdwallet.js>`_, the official port of this library. Try it live at https://hdwallet.online, our interactive web playground.
3332

3433
.. list-table::
3534
:widths: 30 200

0 commit comments

Comments
 (0)