From 890c5a7d75add35d6f5d320e851d1bfee3c60876 Mon Sep 17 00:00:00 2001 From: meherett Date: Mon, 11 Nov 2024 11:45:32 +0300 Subject: [PATCH] Update: README.md and index.rst repo names --- README.md | 28 ++++++++-------------------- docs/index.rst | 27 +++++++++++++-------------- 2 files changed, 21 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 80b3ae3..c2ac1bb 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,16 @@ -

- BIP38
Bitcoin Improvement Proposal - 0038 -

+# Bitcoin Improvement Proposal - 0038 / BIP38 -

- Releases · Manual · API Docs · Donation -

- -
- -[![Build Status](https://img.shields.io/github/actions/workflow/status/meherett/python-bip38/build.yml)](https://github.com/meherett/python-bip38/actions/workflows/build.yml) +[![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) [![PyPI Version](https://img.shields.io/pypi/v/bip38.svg?color=blue)](https://pypi.org/project/bip38) [![Documentation Status](https://readthedocs.org/projects/bip38/badge/?version=master)](https://bip38.readthedocs.io) [![PyPI License](https://img.shields.io/pypi/l/bip38?color=black)](https://pypi.org/project/bip38) [![PyPI Python Version](https://img.shields.io/pypi/pyversions/bip38.svg)](https://pypi.org/project/bip38) -[![Coverage Status](https://coveralls.io/repos/github/meherett/python-bip38/badge.svg?branch=master)](https://coveralls.io/github/meherett/python-bip38) - -
+[![Coverage Status](https://coveralls.io/repos/github/talonlab/python-bip38/badge.svg?branch=master)](https://coveralls.io/github/talonlab/python-bip38) A Python library for the implementation of Bitcoin Improvement Proposal - 0038 / (BIP38) protocol. 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. It's specifically tailored for Pay-to-PubKey-Hash (P2PKH) address types. -![Desktop Application](docs/static/gif/bip38.gif) - For more info see the [Passphrase-protected private key - BIP38](https://en.bitcoin.it/wiki/BIP_0038) spec. ## Installation @@ -36,7 +24,7 @@ pip install bip38 If you want to run the latest version of the code, you can install from the git: ``` -pip install git+git://github.com/meherett/python-bip38.git +pip install git+ssh://github.com/talonlab/python-bip38.git ``` ## Quick Usage @@ -429,7 +417,7 @@ BIP38 Decrypted: { To get started, just fork this repo, clone it locally, and run: ``` -pip install -e .[desktop,tests,docs] +pip install -e .[tests,docs] ``` ## Testing @@ -445,12 +433,12 @@ tests against a specific version of Python. ## Contributing -Feel free to open an [issue](https://github.com/meherett/python-bip38/issues) if you find a problem, +Feel free to open an [issue](https://github.com/talonlab/python-bip38/issues) if you find a problem, or a pull request if you've solved an issue. And also any help in testing, development, documentation and other tasks is highly appreciated and useful to the project. There are tasks for contributors of all experience levels. -For more information, see the [CONTRIBUTING.md](https://github.com/meherett/python-bip38/blob/master/CONTRIBUTING.md) file. +For more information, see the [CONTRIBUTING.md](https://github.com/talonlab/python-bip38/blob/master/CONTRIBUTING.md) file. ## Supported Cryptocurrencies @@ -469,4 +457,4 @@ Thank you very much for your support. ## License -Distributed under the [MIT](https://github.com/meherett/python-bip38/blob/master/LICENSE) license. See ``LICENSE`` for more information. +Distributed under the [MIT](https://github.com/talonlab/python-bip38/blob/master/LICENSE) license. See ``LICENSE`` for more information. diff --git a/docs/index.rst b/docs/index.rst index 76c8732..05ffb92 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,8 +4,8 @@ Bitcoin Improvement Proposal - 0038 / BIP38 |Build Status| |PyPI Version| |Documentation Status| |PyPI License| |PyPI Python Version| |Coverage Status| -.. |Build Status| image:: https://img.shields.io/github/actions/workflow/status/meherett/python-bip38/build.yml - :target: https://github.com/meherett/python-bip38/actions/workflows/build.yml +.. |Build Status| image:: https://img.shields.io/github/actions/workflow/status/talonlab/python-bip38/build.yml + :target: https://github.com/talonlab/python-bip38/actions/workflows/build.yml .. |PyPI Version| image:: https://img.shields.io/pypi/v/bip38.svg?color=blue :target: https://pypi.org/project/bip38 @@ -19,8 +19,8 @@ Bitcoin Improvement Proposal - 0038 / BIP38 .. |PyPI Python Version| image:: https://img.shields.io/pypi/pyversions/bip38.svg :target: https://pypi.org/project/bip38 -.. |Coverage Status| image:: https://coveralls.io/repos/github/meherett/python-bip38/badge.svg?branch=master - :target: https://coveralls.io/github/meherett/python-bip38?branch=master +.. |Coverage Status| image:: https://coveralls.io/repos/github/talonlab/python-bip38/badge.svg?branch=master + :target: https://coveralls.io/github/talonlab/python-bip38?branch=master A Python library for the implementation of Bitcoin Improvement Proposal - 0038 / (BIP38) protocol. This library supports both `No EC-multiply `_ and `EC-multiply `_ 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: :: - pip install git+git://github.com/meherett/python-bip38.git + pip install git+ssh://github.com/talonlab/python-bip38.git -For the versions available, see the `tags on this repository `_. +For the versions available, see the `tags on this repository `_. Quick Usage =========== @@ -451,11 +451,11 @@ EC multiply: Development =========== -We welcome pull requests. To get started, just fork this `github repository `_, clone it locally, and run: +We welcome pull requests. To get started, just fork this `github repository `_, clone it locally, and run: :: - pip install -e .[desktop,tests,docs] + pip install -e .[tests,docs] Testing @@ -475,21 +475,20 @@ tests against a specific version of Python. Contributing ============ -Feel free to open an `issue `_ if you find a problem, +Feel free to open an `issue `_ if you find a problem, or a pull request if you've solved an issue. And also any help in testing, development, documentation and other tasks is highly appreciated and useful to the project. There are tasks for contributors of all experience levels. -For more information, see the `CONTRIBUTING.md `_ file. +For more information, see the `CONTRIBUTING.md `_ file. Donations ========= Buy me a coffee if You found this tool helpful: -- **Bitcoin** - 12uaGVdX1t86FXLQ4yYPrRQDCK7xGGu82r -- **Ethereum / Tether** - 0xCCAad7A87fd81553d0F93F743Fb4Fc6B213b228B -- **Bitcoin / Ethereum / Tether** - With Unstoppable `hd.wallet `_ +- **Bitcoin** - 16c7ajUwHEMaafrceuYSrd35SDjmfVdjoS +- **Ethereum / Tether** - 0xD3cbCB0B6F82A03C715D665b72dC44CEf54e6D9B Thank you very much for your support. @@ -497,4 +496,4 @@ Thank you very much for your support. License ======= -Distributed under the `MIT `_ license. See **LICENSE** for more information. +Distributed under the `MIT `_ license. See **LICENSE** for more information.