v1.0.3: Change default behavior to always show help without subcommand; add README.md; update playbook.md
This commit is contained in:
31
README.md
Normal file
31
README.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# pyhdwallet v1.0.2
|
||||
|
||||
A secure, offline command-line tool for generating and recovering BIP39 HD wallets with support for Ethereum, Solana, and Bitcoin.
|
||||
|
||||
## Purpose
|
||||
|
||||
pyhdwallet helps you create new wallets or recover from existing mnemonics/seeds, with built-in PGP encryption for secure storage. It's designed for privacy-conscious users who want offline, auditable wallet management.
|
||||
|
||||
## Installation
|
||||
|
||||
1. Ensure Python 3.11+ is installed.
|
||||
2. Clone/download the repo.
|
||||
3. Create a virtual environment: `python -m venv .venv && source .venv/bin/activate`
|
||||
4. Install dependencies: `pip install -r requirements.txt`
|
||||
|
||||
## Basic Usage
|
||||
|
||||
Run the tool with a subcommand. For help, use `-h`.
|
||||
|
||||
- Generate a wallet: `python ./src/pyhdwallet.py gen --chains ethereum --addresses 3`
|
||||
- Recover from mnemonic: `python ./src/pyhdwallet.py recover --mnemonic "your words" --chains bitcoin`
|
||||
- Fetch PGP key: `python ./src/pyhdwallet.py fetchkey "https://example.com/key.asc"`
|
||||
- Run tests: `python ./src/pyhdwallet.py test`
|
||||
|
||||
For detailed examples and security tips, see `playbook.md`.
|
||||
|
||||
## Security
|
||||
|
||||
- Operates offline by default.
|
||||
- Use `--secure-mode` for high-security operations.
|
||||
- Always verify PGP keys and run on trusted systems.
|
||||
Reference in New Issue
Block a user