Skip to content

Polish README: add badges, tighten pitch, fix dead links#3

Merged
ilia3546 merged 1 commit into
mainfrom
docs/readme-polish
May 5, 2026
Merged

Polish README: add badges, tighten pitch, fix dead links#3
ilia3546 merged 1 commit into
mainfrom
docs/readme-polish

Conversation

@ilia3546

@ilia3546 ilia3546 commented May 5, 2026

Copy link
Copy Markdown
Owner

Summary

  • Punch up the README so the plugin's value lands in the first screenful: one-line pitch, a runnable command up top, and a Features section calling out themes, layouts, subcommand trees, and per-command overrides.
  • Add badges (CI, Swift versions, Platforms, License, Boosty support) for parity with swift-argument-parser-mcp and to surface project health on Swift Package Index.
  • Fix two dead links in the "Why" section:
    • apple/swift-argument-parser/tree/main/Plugins/GenerateManualPluginPlugins/GenerateManual
    • swiftlang/swift-argument-parser-docs (repo doesn't exist) → apple/swift-argument-parser/tree/main/Plugins/GenerateDoccReference
  • Add a Requirements section reflecting the actual CI matrix (Swift 5.9/6.0, macOS 12+, Linux).

Test plan

  • Render the README on GitHub and confirm all badges resolve.
  • Confirm the two previously-broken reference links now load (200 OK).
  • Spot-check that no technical content (config schema, RenderContext, theme table) was lost in the rewrite.

🤖 Generated with Claude Code

- Add CI, Swift, Platforms, License, and Boosty badges to surface project
  health and ease discovery on Swift Package Index.
- Lead with a one-line value proposition and a runnable example so the
  README sells the plugin in the first screenful.
- Add a "Features" section that calls out themes, layouts, subcommand
  trees, and per-command overrides.
- Fix two dead links: GenerateManualPlugin (now Plugins/GenerateManual)
  and the non-existent swiftlang/swift-argument-parser-docs repo (DocC
  generator now lives in Plugins/GenerateDoccReference).
- Add Requirements section reflecting actual CI matrix (Swift 5.9/6.0,
  macOS 12+, Linux).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@ilia3546 ilia3546 merged commit d64a453 into main May 5, 2026
4 checks passed
@ilia3546 ilia3546 deleted the docs/readme-polish branch May 5, 2026 07:39
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