Check if README is correct

[rubenhensen]

This is a test issue for Dobby Webhook

[rubenhensen]

@dobby take a look at this issue

[rubenhensen]

@dobby take a look at this issue

[rubenhensen]

@dobby take a look at this issue

[rubenhensen]

@dobby take a look at this issue

[dobby-coder]

Dobby has seen the request! 🧹 Dobby is most eager to help with testing! Dobby will look at the project right away and make sure everything is working properly, sir!

[dobby-coder]

Dobby has heard the call again! 🧦 Dobby will thoroughly examine the README to make sure it is correct, sir! Dobby takes great pride in checking every detail!

[dobby-coder]

I reviewed all the READMEs against the actual codebase and found several issues:

pg-dotnet/README.md:

• Listed ".NET 8.0+ SDK" as a prerequisite, but the project targets net10.0 — fixed to ".NET 10.0+ SDK"
• Listed "Rust toolchain" as a prerequisite and had instructions to clone/build postguard-dotnet from source — but the project now uses the E4A.PostGuard NuGet package (v0.2.1), so none of that is needed. Removed the outdated setup steps.

pg-sveltekit/README.md:

• Was entirely the default SvelteKit template README (sv create boilerplate) — had no information about PostGuard, the required environment variables, or the @e4a/pg-js dependency. Rewrote it with proper project documentation.

Root README:

• Didn't exist at all. Added one linking to both examples.

Draft PR: #9

[dobby-coder]

README Review Results

I cloned the repo, reviewed both READMEs against the actual code, and built the SvelteKit project. Here's what I found:

1. pg-sveltekit/README.md — Needs replacement (default template)

The current README is the auto-generated SvelteKit scaffold README ("Everything you need to build a Svelte project, powered by sv"). It doesn't describe this project at all. Missing:

• What the app does — It's a PostGuard encryption demo that encrypts files and uploads/delivers them via Cryptify, using @e4a/pg-js
• Environment variables — The .env.example defines PUBLIC_PKG_URL, PUBLIC_CRYPTIFY_URL, PUBLIC_APP_NAME, and PG_API_KEY, but the README doesn't mention any of them
• Prerequisites — The project uses WASM (vite-plugin-wasm, vite-plugin-top-level-await) and the @e4a/pg-js package, none of which are documented
• Setup instructions — No mention of copying .env.example to .env and setting the API key

2. pg-dotnet/README.md — Good, with one inaccuracy

This README is well-written and project-specific. One issue:

• Prerequisites say ".NET 8.0+ SDK", but PostGuard.Example.csproj targets net10.0. This should say .NET 10.0+ SDK to match the actual target framework.

3. No root README.md

The repository has no top-level README explaining that this is a collection of PostGuard example applications, listing the available examples (pg-sveltekit, pg-dotnet), or linking to the main PostGuard project.

Build/Test Results

• pg-sveltekit: npm install ✅, svelte-check ✅ (0 errors, 1 warning about state_referenced_locally), npm run build ✅, npm run lint ❌ (2 files have Prettier formatting issues in src/lib/postguard/encryption.ts and src/routes/+page.svelte)
• pg-dotnet: Could not build (.NET SDK not available in this environment), but code review looks correct against the README's documented API

Summary of Recommended Fixes

Priority	Issue	Fix
High	pg-sveltekit/README.md is generic template	Replace with project-specific README
Medium	No root README.md	Add repo-level README listing examples
Low	pg-dotnet prereq says .NET 8.0+	Change to .NET 10.0+ (matches net10.0 TFM)
Low	2 files have Prettier formatting issues	Run npm run format

Let me know if you'd like me to create a PR to fix any or all of these issues.

[rubenhensen]

@dobby create a pr fixing these issues

[dobby-coder]

Dobby has seen the request, sir! Dobby is most eager to fix these issues! Dobby will read the issues carefully and create a proper PR right away, sir! 🧹✨

[dobby-coder]

PR #9 has been updated with all the fixes from my review:

Already in the PR (from earlier):

• pg-sveltekit/README.md — Replaced the default SvelteKit template with project-specific documentation (what the app does, prerequisites, env vars table, setup/run/build instructions)
• pg-dotnet/README.md — Fixed .NET version from 8.0 to 10.0 (matching net10.0 TFM), removed outdated Rust toolchain prerequisite and build-from-source setup steps (project uses NuGet package now)
• Root README.md — Added a top-level README listing both example projects

Added just now:

• Prettier formatting — Fixed code style issues in encryption.ts, +page.svelte, and the new README table formatting. npm run lint now passes clean.

Verification:

• npm run lint ✅ (Prettier + ESLint pass)
• svelte-check ✅ (0 errors, 1 pre-existing warning)
• npm run build ✅

PR: #9