docs: add deployment repo README

This commit is contained in:
LC mac
2026-01-28 12:49:09 +08:00
parent b1d3406cc7
commit 307a97516a
2 changed files with 53 additions and 0 deletions

48
public/README.md Normal file
View File

@@ -0,0 +1,48 @@
# SeedPGP Web App
**Secure BIP39 mnemonic backup tool using PGP encryption**
🔗 **Live App**: https://kccleoc.github.io/seedpgp-web-app/
## About
This is a client-side web application for encrypting cryptocurrency seed phrases (BIP39 mnemonics) using OpenPGP encryption and Base45 encoding for QR code generation.
### Features
- 🔐 PGP encryption with cv25519 (Curve25519)
- 📱 QR code-ready output (Base45 + CRC16)
- ✅ Supports 12/18/24-word BIP39 mnemonics
- 🔒 All encryption happens in your browser (client-side only)
## Security Notice
⚠️ **Your private keys and seed phrases never leave your browser**
- This is a static web app with no backend server
- All cryptographic operations run locally in your browser
- No data is transmitted to any server
- Always verify you're on the correct URL before use
### For Maximum Security
For production use with real funds:
- Download and run locally
- Or use a self-hosted version
- Source code: https://github.com/kccleoc/seedpgp-web
## How to Use
1. **Encrypt**: Enter your mnemonic + PGP public key → Get QR code
2. **Decrypt**: Scan QR code + provide private key → Recover mnemonic
## Version
Current deployment: **v1.1.0**
Last updated: 2026-01-28
---
Built with TypeScript, React, Vite, and OpenPGP.js v6

View File

@@ -11,6 +11,9 @@ fi
echo "🔨 Building $VERSION..." echo "🔨 Building $VERSION..."
bun run build bun run build
echo "📄 Adding README..."
cp public/README.md dist/README.md
echo "📦 Deploying to GitHub Pages..." echo "📦 Deploying to GitHub Pages..."
cd dist cd dist
git add . git add .
@@ -19,4 +22,6 @@ git push
cd .. cd ..
echo "✅ Deployed to https://kccleoc.github.io/seedpgp-web-app/" echo "✅ Deployed to https://kccleoc.github.io/seedpgp-web-app/"
echo "📖 Repo: https://github.com/kccleoc/seedpgp-web-app"
echo "🏷️ Don't forget to tag: git tag $VERSION && git push --tags" echo "🏷️ Don't forget to tag: git tag $VERSION && git push --tags"