Skip to content

Rewrite README against Claude Design handoff (929 -> 248 lines)#412

Merged
NagyVikt merged 1 commit intomainfrom
agent/claude/readme-design-simpler-2026-04-24-00-47
Apr 23, 2026
Merged

Rewrite README against Claude Design handoff (929 -> 248 lines)#412
NagyVikt merged 1 commit intomainfrom
agent/claude/readme-design-simpler-2026-04-24-00-47

Conversation

@NagyVikt
Copy link
Copy Markdown
Collaborator

Automated by gx branch finish (PR flow).

Reshapes `README.md` to the structure from design bundle
`sD7EkVZ0h5_9u9LsrWjEDA` (Claude Design handoff, file `readme.html`).
GitHub markdown can't render the dark stone-and-moss aesthetic, but the
narrative structure translates cleanly:

  01 Install in one line    (3-line code block + "the promise" tagline)
  02 The problem            (before/after 2-col GFM table)
  03 What it does           (8 feature bullets)
  04 Daily workflow         (4-step table + single bash block + TIP)
  05 What `gx` shows first  (terminal preview fenced block)
  06 How AGENTS.md handled  (IMPORTANT admonition + 4-row table)
  07 Commands               (Core / Lifecycle / Protected branches)
  08 v6 -> v7 migration     (8-row rename table)
  09 Known rough edges      (3 bullets)

Preserves the existing shields.io badge URLs (npm, downloads, CI,
OpenSSF, stars, last-commit, license) so live badges keep rendering on
npm / GitHub mirrors.

Uses GFM admonitions (`> [!WARNING]`, `> [!IMPORTANT]`, `> [!TIP]`)
instead of the design's custom callout boxes so the warnings render
natively on GitHub.

Bumps `@imdeadpool/guardex` 7.0.31 -> 7.0.32 so the next `npm publish`
ships the new README.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@NagyVikt NagyVikt merged commit f0ef368 into main Apr 23, 2026
@NagyVikt NagyVikt deleted the agent/claude/readme-design-simpler-2026-04-24-00-47 branch April 23, 2026 22:52
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