Skip to content

README: slim to a landing page (mission, install, security, wiki, licence) - #292

Merged
nathanpond merged 1 commit into
mainfrom
readme-slim
Aug 27, 2026
Merged

nathanpond merged 1 commit into
mainfrom
readme-slim

Conversation

@nathanpond

Copy link
Copy Markdown
Owner

The README had grown to 2,830 lines — 89% of it two sections (Matching Word ~1,400, Current scope ~1,130). Replaced with a concise 106-line landing page in the requested shape:

  1. Mission — .docx→PDF from scratch, aiming for pixel-parity with Word, and why: rendering is the hard part most from-scratch OSS options never got right, so every layout rule was measured from Word's own output.
  2. Installation — dotnet add package n8PDF, usage patterns, options pointer.
  3. Security — names the attack surface and lists the mitigations (limits, DTD prohibition, image caps, the decoder net, checked arithmetic, fuzzing, CodeQL/Semgrep, cancellation, trusted publishing + provenance).
  4. More in the wiki — links to the full account.
  5. Licence — MIT.

The wiki pages summarise these; the README's deepest detail (full fidelity measurements, exhaustive scope) now lives only in git history — recoverable, and I can migrate it into the wiki if you want it live. Package unaffected (uses PACKAGE.md); CLAUDE.md navigation now points at the wiki.

🤖 Generated with Claude Code

…cence

The README had grown to 2,830 lines, most of it the deep fidelity narrative
(Matching Word, ~1,400 lines) and the exhaustive scope list (Current scope,
~1,130). Replace it with a concise landing page: the mission (pixel-parity
with Word, and why from-scratch rendering is the hard part most options miss),
install and usage, a security section that names the attack surface and the
mitigations, a pointer to the wiki for the full account, and the licence.

The wiki already carries all of these as pages; the deepest measurement and
scope detail was in the README's history and is recoverable from git. Updates
CLAUDE.md's navigation to point at the wiki rather than README line numbers.
The published package is unaffected — it uses PACKAGE.md, not README.md.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018z5C7uNEvN24w5mSrN9sV7
@nathanpond
nathanpond merged commit 38413fb into main Aug 27, 2026
9 checks passed
@nathanpond
nathanpond deleted the readme-slim branch August 27, 2026 15:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant