Skip to content

Commit

Permalink
Modify: README.md & CONTRIBUTING.md some links
Browse files Browse the repository at this point in the history
  • Loading branch information
meherett committed Nov 27, 2024
1 parent 550f55f commit 3edf9be
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 17 deletions.
16 changes: 11 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

First off, thanks for taking the time to contribute and
when contributing to this repository, please first discuss
the change you wish to make via [issue](https://github.com/meherett/hdwallet/issues)
the change you wish to make via [issue](https://github.com/talonlab/hdwallet/issues)
with the owners of this repository before making a change.

## Development

To get started, just fork this repo, clone it locally, and run:

```
$ pip install -e .[tests,docs] -r requirements.txt
pip install -e .[cli,tests,docs] -r requirements.txt
```

## Pull Request
Expand All @@ -37,19 +37,25 @@ git push origin new-feature
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Include any relevant documentation updates

GitHub's documentation for working on pull requests is [available here](https://help.github.com/articles/about-pull-requests/).
GitHub's documentation for working on pull requests is [available here](https://help.github.com/articles/about-pull-requests).

## Testing

You can run the tests with:

```
$ pytest
coverage run -m pytest
```

To see the coverage:

```
coverage report
```

Or use `tox` to run the complete suite against the full set of build targets, or pytest to run specific
tests against a specific version of Python.

## License

Distributed under the [ISC](https://github.com/meherett/python-hdwallet/blob/master/LICENSE) license. See ``LICENSE`` for more information.
Distributed under the [MIT](https://github.com/talonlab/python-hdwallet/blob/master/LICENSE) license. See ``LICENSE`` for more information.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img height="100" alt="HDWallet" src="./docs/static/svg/hdwallet-logo.svg">
<img height="100" alt="HDWallet" src="https://raw.githubusercontent.com/talonlab/python-hdwallet/refs/heads/master/docs/static/svg/hdwallet-logo.svg">

# Hierarchical Deterministic (HD) Wallet

Expand Down Expand Up @@ -155,15 +155,15 @@ print(json.dumps(hdwallet.dump(exclude={"indexes"}), indent=4, ensure_ascii=Fals
```
</details>

Explore more [Examples](./examples)
Explore more [Examples](https://github.com/talonlab/python-hdwallet/blob/master/examples)

### Command Line Interface (CLI)

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.

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

Explore more [Commands](./examples#readme)
Explore more [Commands](https://github.com/talonlab/python-hdwallet/blob/master/examples#readme)

### Clients

Expand Down Expand Up @@ -234,7 +234,7 @@ m/44'/60'/0'/0/10 0xEf4ba16373841C53a9Ba168873fC3967118C1d37 0x1d8e676c6da57922d
```
</details>

Explore more [Clients](./clients)
Explore more [Clients](https://github.com/talonlab/python-hdwallet/blob/master/clients)

## Development

Expand Down Expand Up @@ -263,12 +263,12 @@ tests against a specific version of Python.

## Contributing

Feel free to open an [issue](https://github.com/talonlab/hdwallet/issues) if you find a problem,
Feel free to open an [issue](https://github.com/talonlab/python-hdwallet/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](./CONTRIBUTING.md) file.
For more information, see the [CONTRIBUTING.md](https://github.com/talonlab/python-hdwallet/blob/master/CONTRIBUTING.md) file.

## Supported Cryptocurrencies

Expand Down Expand Up @@ -487,12 +487,12 @@ This library simplifies the process of creating a new Hierarchical Deterministic

## Donations

If you found this tool helpful, consider making a donation and help this repo reach ⭐!
If you found this tool useful, consider supporting its development with a donation and help this repository gain more ⭐!

| Coins | Addresses |
|-------------|:-------------------------------------------|
| BTC | 16c7ajUwHEMaafrceuYSrd35SDjmfVdjoS |
| ETH, ERC-20 | 0xD3cbCB0B6F82A03C715D665b72dC44CEf54e6D9B |
- **Bitcoin** - 16c7ajUwHEMaafrceuYSrd35SDjmfVdjoS
- **Ethereum / ERC20** - 0xD3cbCB0B6F82A03C715D665b72dC44CEf54e6D9B

Thank you very much for your support.

## License

Expand Down

0 comments on commit 3edf9be

Please sign in to comment.