Skip to content

Commit ee1b565

Browse files
committed
docs: updated README.md
1 parent dcac04f commit ee1b565

File tree

1 file changed

+3
-10
lines changed

1 file changed

+3
-10
lines changed

README.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ This project follows the principles of [Keep a Changelog](https://keepachangelog
8383
│ ├── hooks.server.js # Injects CSP headers and permissions policy
8484
│ └── service-worker.js # Custom PWA service worker
8585
├── static/ # Public assets served at site root
86-
│ ├── pgp/ # PGP keys and QR code images
86+
│ ├── pgp/ # PGP keys
8787
│ ├── disableSw.js # Service worker bypass (via ?nosw param)
8888
│ ├── manifest.json # PWA metadata
8989
│ ├── robots.txt # SEO: allow/disallow crawlers
@@ -106,26 +106,19 @@ This project follows the principles of [Keep a Changelog](https://keepachangelog
106106

107107
### 🔐 `static/pgp/` Directory Structure
108108

109-
This directory contains public PGP key files and their corresponding QR codes.
109+
This directory contains public PGP key files. Their corresponding QR code images are now loaded dynamically from `src/lib/img/qr`. A dynamic QR code import utility in `src/lib/images.js` allows these files to be imported directly from `$lib`.
110110

111111
```bash
112112
static/
113113
├── pgp/
114114
│ ├── contact@s.neteng.pro.asc # Public key for secure email
115-
│ ├── pgp-contact.png # QR code (PNG) for secure email key
116-
│ ├── pgp-contact.webp # Optimized WebP version of the QR code
117-
│ ├── pgp-security.png # QR code (PNG) for security contact key
118-
│ ├── pgp-security.webp # WebP version of the security QR code
119-
│ ├── pgp-support.png # QR code (PNG) for support key
120-
│ ├── pgp-support.webp # WebP version of the support QR code
121115
│ ├── security@s.neteng.pro.asc # Public key for security contact
122116
│ ├── support@neteng.pro.asc # Public key for general support
123117
└── ...
124118
```
125119

126120
- `.asc` files are **excluded from service worker precaching** but served directly via the `/pgp/[key]` route.
127-
- QR code images are **served statically** by the `/pgp` route using `<picture>` elements.
128-
- **WebP versions** are also used in the `/pgp` route, while the `/about` route imports **dynamic equivalents** from `src/lib/img/qr`.
121+
- QR code images—including WebP and PNG versions—are **served dynamically** from `src/lib/img/qr` using `<picture>` elements.
129122
- This route does **not use fallback rendering**; only explicitly defined files are available and expected to resolve.
130123
- A dynamic `[key]/+server.js` handler under `src/routes/pgp/` serves the `.asc` files with appropriate `Content-Type` and download headers.
131124

0 commit comments

Comments
 (0)