From 307a97516a7e43717dccf5e2eb7722aff7147016 Mon Sep 17 00:00:00 2001
From: LC mac <leochan@hkjin.com>
Date: Wed, 28 Jan 2026 12:49:09 +0800
Subject: [PATCH] docs: add deployment repo README

---
 public/README.md  | 48 +++++++++++++++++++++++++++++++++++++++++++++++
 scripts/deploy.sh |  5 +++++
 2 files changed, 53 insertions(+)
 create mode 100644 public/README.md

diff --git a/public/README.md b/public/README.md
new file mode 100644
index 0000000..0b8e1b6
--- /dev/null
+++ b/public/README.md
@@ -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
+
diff --git a/scripts/deploy.sh b/scripts/deploy.sh
index 7ff1fae..d4fae07 100755
--- a/scripts/deploy.sh
+++ b/scripts/deploy.sh
@@ -11,6 +11,9 @@ fi
 echo "🔨 Building $VERSION..."
 bun run build
 
+echo "📄 Adding README..."
+cp public/README.md dist/README.md
+
 echo "📦 Deploying to GitHub Pages..."
 cd dist
 git add .
@@ -19,4 +22,6 @@ git push
 
 cd ..
 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"
+