Skip to content

Commit de2e6ee

Browse files
meherettmeherett
committed
Update: BIP-0038 docs & README.md
1 parent 36fafc0 commit de2e6ee

6 files changed

Lines changed: 54 additions & 55 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
First off, thanks for taking the time to contribute and
44
when contributing to this repository, please first discuss
5-
the change you wish to make via [issue](https://github.com/talonlab/python-bip38/issues)
5+
the change you wish to make via [issue](https://github.com/hdwallet-io/python-bip38/issues)
66
with the owners of this repository before making a change.
77

88
## Development
@@ -58,4 +58,4 @@ tests against a specific version of Python.
5858

5959
## License
6060

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

‎README.md‎

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
1-
<div>
2-
<a target="_blank" href="https://github.com/talonlab/bip38-desktop"><img align="right" height="25" alt="Desktop" src="https://img.shields.io/badge/desktop-65619c"></a>
3-
<img height="100" alt="BIP38" src="https://raw.githubusercontent.com/talonlab/python-bip38/refs/heads/master/docs/static/svg/bip38-logo.svg">
4-
</div>
5-
61
# Bitcoin Improvement Proposal - 0038 / BIP38
72

8-
[![Build Status](https://img.shields.io/github/actions/workflow/status/talonlab/python-bip38/build.yml)](https://github.com/talonlab/python-bip38/actions/workflows/build.yml)
3+
[![Build Status](https://img.shields.io/github/actions/workflow/status/hdwallet-io/python-bip38/build.yml)](https://github.com/hdwallet-io/python-bip38/actions/workflows/build.yml)
94
[![PyPI Version](https://img.shields.io/pypi/v/bip38.svg?color=blue)](https://pypi.org/project/bip38)
105
[![Documentation Status](https://readthedocs.org/projects/bip38/badge/?version=master)](https://bip38.readthedocs.io)
116
[![PyPI License](https://img.shields.io/pypi/l/bip38?color=black)](https://pypi.org/project/bip38)
127
[![PyPI Python Version](https://img.shields.io/pypi/pyversions/bip38.svg)](https://pypi.org/project/bip38)
13-
[![Coverage Status](https://coveralls.io/repos/github/talonlab/python-bip38/badge.svg?branch=master)](https://coveralls.io/github/talonlab/python-bip38)
8+
[![Coverage Status](https://coveralls.io/repos/github/hdwallet-io/python-bip38/badge.svg?branch=master)](https://coveralls.io/github/hdwallet-io/python-bip38)
149

1510
A Python library for the implementation of Bitcoin Improvement Proposal - 0038 / (BIP38) protocol.
1611
This library supports both [No EC-multiply](https://github.com/bitcoin/bips/blob/master/bip-0038.mediawiki#encryption-when-ec-multiply-flag-is-not-used) and [EC-multiply](https://github.com/bitcoin/bips/blob/master/bip-0038.mediawiki#encryption-when-ec-multiply-mode-is-used) modes and is compatible with over 150+ cryptocurrencies.
@@ -29,7 +24,7 @@ pip install bip38
2924
If you want to run the latest version of the code, you can install from the git:
3025

3126
```
32-
pip install git+ssh://github.com/talonlab/python-bip38.git
27+
pip install git+ssh://github.com/hdwallet-io/python-bip38.git
3328
```
3429

3530
## Quick Usage
@@ -444,12 +439,12 @@ tests against a specific version of Python.
444439

445440
## Contributing
446441

447-
Feel free to open an [issue](https://github.com/talonlab/python-bip38/issues) if you find a problem,
442+
Feel free to open an [issue](https://github.com/hdwallet-io/python-bip38/issues) if you find a problem,
448443
or a pull request if you've solved an issue. And also any help in testing, development,
449444
documentation and other tasks is highly appreciated and useful to the project.
450445
There are tasks for contributors of all experience levels.
451446

452-
For more information, see the [CONTRIBUTING.md](https://github.com/talonlab/python-bip38/blob/master/CONTRIBUTING.md) file.
447+
For more information, see the [CONTRIBUTING.md](https://github.com/hdwallet-io/python-bip38/blob/master/CONTRIBUTING.md) file.
453448

454449
## Supported Cryptocurrencies
455450

@@ -459,14 +454,21 @@ This module supports more than 150+ cryptocurrencies, including the following:
459454

460455
## Donations
461456

462-
Buy me a coffee if You found this tool helpful:
457+
If this tool was helpful, support its development with a donation or a ⭐!
463458

464-
- **Bitcoin** - 16c7ajUwHEMaafrceuYSrd35SDjmfVdjoS
465-
- **Ethereum / ERC20** - 0xD3cbCB0B6F82A03C715D665b72dC44CEf54e6D9B
466-
- **Solana** - 9cVoan5GvnpVvysEkFWEFR4k9cpTdWKmqQ6Gi7nwM5ES
459+
- **Monero**: `47xYi7dw4VchWhbhacY6RZHDmmcxZdzPE9tLk84c7hE72bw6aLSMVFWPXxGMEEYofkjNjxoWfnLSHejS6yzRGnPqEtxfgZi`
460+
- **EVM-Chains**: `0xD3cbCB0B6F82A03C715D665b72dC44CEf54e6D9B` | `meherett.eth`
461+
- **Bitcoin**: `16c7ajUwHEMaafrceuYSrd35SDjmfVdjoS`
467462

468-
Thank you very much for your support.
463+
> [!TIP]
464+
> We accept a wide range of cryptocurrencies! If you'd like to donate using another coin, generate an address using the following ECC public keys at [https://hdwallet.online](https://hdwallet.online):
465+
>
466+
> - **SLIP10-Secp256k1**: [029890465120fb6c4efecdfcfd149f8333b0929b98976722a28ee39f5344d29eee](https://hdwallet.online/dumps/slip10-secp256k1/BTC?network=mainnet&hd=BIP32&from=public-key&public-key=029890465120fb6c4efecdfcfd149f8333b0929b98976722a28ee39f5344d29eee&public-key-type=compressed&format=JSON&exclude=root&generate=true)
467+
> - **SLIP10-Ed25519**: [007ff5643c73e46e6c6a0dfd702894610505423e145dc8a93df19ff44eb011323b](https://hdwallet.online/dumps/slip10-ed25519/ALGO?network=mainnet&hd=BIP32&from=public-key&public-key=007ff5643c73e46e6c6a0dfd702894610505423e145dc8a93df19ff44eb011323b&format=JSON&exclude=root&generate=true)
468+
> - **Kholaw-Ed25519**: [005a49188ccd3d841dd877d7c00078da5c90452cbd69d4cef7a959f679fcc0e0e3](https://hdwallet.online/dumps/kholaw-ed25519/ADA?network=mainnet&hd=Cardano&from=public-key&public-key=005a49188ccd3d841dd877d7c00078da5c90452cbd69d4cef7a959f679fcc0e0e3&staking-public-key=005a49188ccd3d841dd877d7c00078da5c90452cbd69d4cef7a959f679fcc0e0e3&address-type=payment&format=JSON&exclude=root&generate=true)
469+
> - **SLIP10-Ed25519-Blake2b**: [0051e8b29f7d0214dc96843cdbdcc071dc65397016ea6f7381f81bf42d76c7357c](https://hdwallet.online/dumps/slip10-ed25519-blake2b/XNO?network=mainnet&hd=BIP32&from=public-key&public-key=0051e8b29f7d0214dc96843cdbdcc071dc65397016ea6f7381f81bf42d76c7357c&format=JSON&exclude=root&generate=true)
470+
> - **SLIP10-Nist256p1**: [039ee4e2aadd6f4e7938d164b646c4b424114b8dd57252287151398ba0baf25780](https://hdwallet.online/dumps/slip10-nist256p1/NEO?network=mainnet&hd=BIP32&from=public-key&public-key=039ee4e2aadd6f4e7938d164b646c4b424114b8dd57252287151398ba0baf25780&format=JSON&exclude=root&generate=true)
469471
470472
## License
471473

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

‎docs/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
# a list of builtin themes.
5656
html_theme = "furo"
5757
# Product logo name
58-
html_logo = "static/svg/bip38-logo.svg"
58+
# html_logo = "static/svg/bip38-logo.svg"
5959
# Theme options
6060
html_theme_options = {
6161
# "canonical_url": "",

‎docs/index.rst‎

Lines changed: 9 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Bitcoin Improvement Proposal - 0038 / BIP38
44

55
|Build Status| |PyPI Version| |Documentation Status| |PyPI License| |PyPI Python Version| |Coverage Status|
66

7-
.. |Build Status| image:: https://img.shields.io/github/actions/workflow/status/talonlab/python-bip38/build.yml
8-
:target: https://github.com/talonlab/python-bip38/actions/workflows/build.yml
7+
.. |Build Status| image:: https://img.shields.io/github/actions/workflow/status/hdwallet-io/python-bip38/build.yml
8+
:target: https://github.com/hdwallet-io/python-bip38/actions/workflows/build.yml
99

1010
.. |PyPI Version| image:: https://img.shields.io/pypi/v/bip38.svg?color=blue
1111
:target: https://pypi.org/project/bip38
@@ -19,8 +19,8 @@ Bitcoin Improvement Proposal - 0038 / BIP38
1919
.. |PyPI Python Version| image:: https://img.shields.io/pypi/pyversions/bip38.svg
2020
:target: https://pypi.org/project/bip38
2121

22-
.. |Coverage Status| image:: https://coveralls.io/repos/github/talonlab/python-bip38/badge.svg?branch=master
23-
:target: https://coveralls.io/github/talonlab/python-bip38?branch=master
22+
.. |Coverage Status| image:: https://coveralls.io/repos/github/hdwallet-io/python-bip38/badge.svg?branch=master
23+
:target: https://coveralls.io/github/hdwallet-io/python-bip38?branch=master
2424

2525
A Python library for the implementation of Bitcoin Improvement Proposal - 0038 / (BIP38) protocol.
2626
This library supports both `No EC-multiply <https://github.com/bitcoin/bips/blob/master/bip-0038.mediawiki#encryption-when-ec-multiply-flag-is-not-used>`_ and `EC-multiply <https://github.com/bitcoin/bips/blob/master/bip-0038.mediawiki#encryption-when-ec-multiply-mode-is-used>`_ modes and is compatible with over 150+ cryptocurrencies.
@@ -42,10 +42,10 @@ If you want to run the latest version of the code, you can install from git:
4242

4343
::
4444

45-
pip install git+ssh://github.com/talonlab/python-bip38.git
45+
pip install git+ssh://github.com/hdwallet-io/python-bip38.git
4646

4747

48-
For the versions available, see the `tags on this repository <https://github.com/talonlab/python-bip38/tags>`_.
48+
For the versions available, see the `tags on this repository <https://github.com/hdwallet-io/python-bip38/tags>`_.
4949

5050
Quick Usage
5151
===========
@@ -451,7 +451,7 @@ EC multiply:
451451
Development
452452
===========
453453

454-
We welcome pull requests. To get started, just fork this `github repository <https://github.com/talonlab/python-bip38>`_, clone it locally, and run:
454+
We welcome pull requests. To get started, just fork this `github repository <https://github.com/hdwallet-io/python-bip38>`_, clone it locally, and run:
455455

456456
::
457457

@@ -475,26 +475,9 @@ tests against a specific version of Python.
475475
Contributing
476476
============
477477

478-
Feel free to open an `issue <https://github.com/talonlab/python-bip38/issues>`_ if you find a problem,
478+
Feel free to open an `issue <https://github.com/hdwallet-io/python-bip38/issues>`_ if you find a problem,
479479
or a pull request if you've solved an issue. And also any help in testing, development,
480480
documentation and other tasks is highly appreciated and useful to the project.
481481
There are tasks for contributors of all experience levels.
482482

483-
For more information, see the `CONTRIBUTING.md <https://github.com/talonlab/python-bip38/blob/master/CONTRIBUTING.md>`_ file.
484-
485-
Donations
486-
=========
487-
488-
Buy me a coffee if You found this tool helpful:
489-
490-
- **Bitcoin** - 16c7ajUwHEMaafrceuYSrd35SDjmfVdjoS
491-
- **Ethereum / Tether** - 0xD3cbCB0B6F82A03C715D665b72dC44CEf54e6D9B
492-
- **Solana** - 9cVoan5GvnpVvysEkFWEFR4k9cpTdWKmqQ6Gi7nwM5ES
493-
494-
Thank you very much for your support.
495-
496-
497-
License
498-
=======
499-
500-
Distributed under the `MIT <https://github.com/talonlab/python-bip38/blob/master/LICENSE>`_ license. See **LICENSE** for more information.
483+
For more information, see the `CONTRIBUTING.md <https://github.com/hdwallet-io/python-bip38/blob/master/CONTRIBUTING.md>`_ file.

‎docs/static/css/bip38.css‎

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,35 @@
11
table.docutils {
2-
margin-left: 5px;
3-
margin-right: auto;
2+
margin-left: 5px;
3+
margin-right: auto;
44
}
55

66
th {
7-
font-weight: bold;
7+
font-weight: bold;
88
}
99

1010
td, th {
11-
text-align: center;
12-
min-width: 20px;
11+
text-align: center;
12+
min-width: 20px;
1313
}
1414

1515
.name {
16-
text-align: left;
16+
text-align: left;
17+
}
18+
19+
.project-title {
20+
font-size: 1.7rem;
21+
font-weight: bold;
22+
text-align: center;
23+
color: var(--color-sidebar-brand-text);
24+
margin-top: 0.5rem;
1725
}
1826

1927
.sidebar-logo-container img {
20-
width: 100px;
21-
height: auto;
28+
width: 100px;
29+
height: auto;
2230
}
2331

2432
.sidebar-brand-text {
25-
text-align: center;
26-
font-size: 19px;
33+
text-align: center;
34+
font-size: 1.2rem;
2735
}

‎docs/templates/sidebar/brand.html‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{% extends "furo/sidebar/brand.html" %}
2+
3+
{% block brand_content %}
4+
<div class="project-title">BIP-0038</div>
5+
{{ super() }}
6+
{% endblock %}

0 commit comments

Comments
 (0)