You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
pg-manual/README.md is six lines of "install and run". It does not explain:
What pg-manual demonstrates (manual encryption via the low-level @e4a/pg-wasm library, vs. the high-level @e4a/pg-js SDK used by pg-sveltekit / pg-node).
That the example flow relies on IRMA demo credentials (`irma-demo.sidn-pbdf.email.email`, `irma-demo.gemeente.personalData.*`) — users need to know to fetch a demo credential from privacybydesign.foundation/attribute-index before running.
That decryption requires a Yivi popup / app-issued key (the WASM example talks to a PKG and pops a Yivi session).
Why two entry points exist (`string.html` vs `file.html`) and what each demonstrates.
Which Cryptify / PKG deployment it targets and whether that is configurable.
The relationship to the root README's listing.
Compare to the other sub-projects:
pg-sveltekit/README.md — full setup, env vars, dev/prod notes
pg-manual is the most architecturally interesting of the four (it's the only one calling the WASM library directly), but the README gives a new reader nothing to go on.
Suggested content
One-paragraph "what this is" — low-level WASM example, contrast with the SDK-based examples.
Prerequisites: Node + browser, a Yivi app on a phone, an IRMA demo credential.
Step-by-step run: npm install, npm run dev, open the printed URL, what each of string.html / file.html does, what the Yivi popup is asking for.
Pointer to examples/utils.js for the PKG_URL and the key-request shape, with a one-line note about the fact that it currently points at the legacy iHub PKG (see #PKG_URL_ISSUE if filed).
"When to use pg-manual vs pg-sveltekit / pg-node": when you need policy-level control the SDK doesn't expose.
Files
pg-manual/README.md — full rewrite
Scope
pg-manual only. Other sub-project READMEs are already adequate.
Problem
pg-manual/README.mdis six lines of "install and run". It does not explain:@e4a/pg-wasmlibrary, vs. the high-level@e4a/pg-jsSDK used bypg-sveltekit/pg-node).Compare to the other sub-projects:
pg-sveltekit/README.md— full setup, env vars, dev/prod notespg-node/README.md— modes table, prerequisites, env-var table, code walkthroughpg-dotnet/README.md— setup, secrets, scenariospg-manualis the most architecturally interesting of the four (it's the only one calling the WASM library directly), but the README gives a new reader nothing to go on.Suggested content
npm install,npm run dev, open the printed URL, what each ofstring.html/file.htmldoes, what the Yivi popup is asking for.examples/utils.jsfor thePKG_URLand the key-request shape, with a one-line note about the fact that it currently points at the legacy iHub PKG (see #PKG_URL_ISSUE if filed).Files
pg-manual/README.md— full rewriteScope
pg-manualonly. Other sub-project READMEs are already adequate.