Skip to content

Commit

Permalink
Update: README.md and index.rst repo names
Browse files Browse the repository at this point in the history
  • Loading branch information
meherett committed Nov 11, 2024
1 parent eba9cc6 commit 890c5a7
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 34 deletions.
28 changes: 8 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,16 @@
<h1 align="center" style="border-bottom: none">
<img height="100" alt="BIP38" src="docs/static/svg/bip38.svg"><br>Bitcoin Improvement Proposal - 0038
</h1>
# Bitcoin Improvement Proposal - 0038 / BIP38

<p align="center">
<a href="https://github.com/meherett/python-bip38/releases" target="_blank">Releases</a> · <a href="https://talonlab.gitbook.io/bip38/manual" target="_blank">Manual</a> · <a href="https://bip38.readthedocs.io" target="_blank">API Docs</a> · <a href="#donations">Donation</a>
</p>

<div align="center">

[![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)

</div>
[![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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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

Expand All @@ -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.
27 changes: 13 additions & 14 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 <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.
Expand All @@ -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 <https://github.com/meherett/python-bip38/tags>`_.
For the versions available, see the `tags on this repository <https://github.com/talonlab/python-bip38/tags>`_.

Quick Usage
===========
Expand Down Expand Up @@ -451,11 +451,11 @@ EC multiply:
Development
===========

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

::

pip install -e .[desktop,tests,docs]
pip install -e .[tests,docs]


Testing
Expand All @@ -475,26 +475,25 @@ 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.

Donations
=========

Buy me a coffee if You found this tool helpful:

- **Bitcoin** - 12uaGVdX1t86FXLQ4yYPrRQDCK7xGGu82r
- **Ethereum / Tether** - 0xCCAad7A87fd81553d0F93F743Fb4Fc6B213b228B
- **Bitcoin / Ethereum / Tether** - With Unstoppable `hd.wallet <https://ud.me/hd.wallet>`_
- **Bitcoin** - 16c7ajUwHEMaafrceuYSrd35SDjmfVdjoS
- **Ethereum / Tether** - 0xD3cbCB0B6F82A03C715D665b72dC44CEf54e6D9B

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.

0 comments on commit 890c5a7

Please sign in to comment.