mirror of
https://github.com/kccleoc/seedpgp-web.git
synced 2026-03-07 01:47:52 +08:00
docs: update version to v1.4.7 and organize documentation
- Update package.json version to v1.4.7 - Update README.md header to v1.4.7 - Update GEMINI.md version references to v1.4.7 - Update RECOVERY_PLAYBOOK.md version to v1.4.7 - Update SECURITY_AUDIT_REPORT.md version to v1.4.7 - Move documentation files to doc/ directory for better organization - Add new documentation files: LOCAL_TESTING_GUIDE.md, SERVE.md, TAILS_OFFLINE_PLAYBOOK.md - Add Makefile and serve.ts for improved development workflow
This commit is contained in:
48
README.md
48
README.md
@@ -1,13 +1,49 @@
|
||||
# SeedPGP v1.4.5
|
||||
# SeedPGP v1.4.7
|
||||
|
||||
**Secure BIP39 mnemonic backup using PGP encryption and QR codes**
|
||||
|
||||
A client-side web app for encrypting cryptocurrency seed phrases with OpenPGP and encoding them as QR-friendly Base45 frames with CRC16 integrity checking.
|
||||
|
||||
**Quick note for Bitcoin users (beginner-friendly):**
|
||||
|
||||
- This tool helps you securely back up your Bitcoin seed phrase (BIP39) by encrypting it with OpenPGP and giving you a compact QR-friendly export. You don't need to understand the internals to use it — follow the Quick Start below and test recovery immediately.
|
||||
- If you are new to Bitcoin: write your seed phrase on paper, keep copies in separate secure locations, and consider using Tails for larger amounts.
|
||||
|
||||
**Live App:** <https://seedpgp-web.pages.dev>
|
||||
|
||||
---
|
||||
|
||||
## 🚦 Quick Start — Bitcoin Beginners
|
||||
|
||||
If you're new to Bitcoin, this short guide gets you from zero to a tested backup in a few minutes.
|
||||
|
||||
1. Clone the repo and install dependencies:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/kccleoc/seedpgp-web.git
|
||||
cd seedpgp-web
|
||||
bun install
|
||||
```
|
||||
|
||||
1. Build the offline bundle and serve it locally (recommended):
|
||||
|
||||
```bash
|
||||
make full-build-offline # builds and verifies dist/
|
||||
make serve-local # start local HTTP server on http://localhost:8000
|
||||
# or: bun run serve # uses Bun server
|
||||
```
|
||||
|
||||
1. Open your browser at `http://localhost:8000`, generate a seed, write it on paper, then encrypt/export using the app.
|
||||
|
||||
2. IMPORTANT: Test recovery immediately — import the backup into the app and confirm the seed matches.
|
||||
|
||||
Notes:
|
||||
|
||||
- Always store the written seed (paper) securely; treat it like cash.
|
||||
- For larger amounts, follow the Tails air-gapped instructions in the `doc/TAILS_OFFLINE_PLAYBOOK.md` file.
|
||||
|
||||
---
|
||||
|
||||
## 💡 Safe Usage Guide: Choose Your Path
|
||||
|
||||
**Before you start**: How much are you backing up? This determines your setup.
|
||||
@@ -263,7 +299,7 @@ You now have:
|
||||
|
||||
## 🛡️ Threat Model & Limitations
|
||||
|
||||
See [MEMORY_STRATEGY.md](MEMORY_STRATEGY.md) for comprehensive explanation of what SeedPGP protects against and what it can't.
|
||||
See [MEMORY_STRATEGY.md](doc/MEMORY_STRATEGY.md) for comprehensive explanation of what SeedPGP protects against and what it can't.
|
||||
|
||||
**TL;DR - Real risks are:**
|
||||
|
||||
@@ -341,9 +377,9 @@ bun test:integration
|
||||
|
||||
## 📖 Technical Documentation
|
||||
|
||||
- [MEMORY_STRATEGY.md](MEMORY_STRATEGY.md) - Why JS can't zero memory and how SeedPGP defends
|
||||
- [RECOVERY_PLAYBOOK.md](RECOVERY_PLAYBOOK.md) - Offline recovery instructions
|
||||
- [SECURITY_AUDIT_REPORT.md](SECURITY_AUDIT_REPORT.md) - Full audit findings
|
||||
- [MEMORY_STRATEGY.md](doc/MEMORY_STRATEGY.md) - Why JS can't zero memory and how SeedPGP defends
|
||||
- [RECOVERY_PLAYBOOK.md](doc/RECOVERY_PLAYBOOK.md) - Offline recovery instructions
|
||||
- [SECURITY_AUDIT_REPORT.md](doc/SECURITY_AUDIT_REPORT.md) - Full audit findings
|
||||
|
||||
---
|
||||
|
||||
@@ -377,7 +413,7 @@ Guard it with your life.
|
||||
|
||||
- **Issues:** [GitHub Issues](https://github.com/kccleoc/seedpgp-web/issues)
|
||||
- **Security:** Private disclosure via GitHub security advisory
|
||||
- **Recovery Help:** See [RECOVERY_PLAYBOOK.md](RECOVERY_PLAYBOOK.md)
|
||||
- **Recovery Help:** See [RECOVERY_PLAYBOOK.md](doc/RECOVERY_PLAYBOOK.md)
|
||||
|
||||
**Author:** kccleoc
|
||||
**Security Audited:** v1.4.4 (no exploits found)
|
||||
|
||||
Reference in New Issue
Block a user