Skip to content

docs: add minimal README to each plugin pointing at keryxjs.com#483

Merged
evantahler merged 2 commits into
mainfrom
claude/add-plugin-readmes-Pl1Rj
Apr 29, 2026
Merged

docs: add minimal README to each plugin pointing at keryxjs.com#483
evantahler merged 2 commits into
mainfrom
claude/add-plugin-readmes-Pl1Rj

Conversation

@evantahler

Copy link
Copy Markdown
Member

Summary

The plugins published to npm (@keryxjs/csrf, @keryxjs/resque-admin, @keryxjs/tracing) had no README, so their npm package pages were blank. Each plugin now ships a short README with a one-line description and a link to its docs page on keryxjs.com, so users landing on npm can find their way to the full guide.

  • Add README.md to each plugin and include it in the files array so it ships in the published tarball
  • Patch-bump each plugin (csrf 0.1.2 → 0.1.3, resque-admin 0.1.3 → 0.1.4, tracing 0.3.2 → 0.3.3)
  • Patch-bump the framework package (keryx 0.30.0 → 0.30.1) per the repo PR convention

Test plan

  • bun lint passes across all workspaces
  • CI green
  • Spot-check the rendered README on each plugin's npm page after publish

https://claude.ai/code/session_017qp9Pn5f1J7LGFZCgkuXLs


Generated by Claude Code

Plugins published to npm previously had no README, leaving the npm
package page blank. Each plugin now ships a short description and a
link to its docs page so users landing on npm can find their way to
the full guide.

https://claude.ai/code/session_017qp9Pn5f1J7LGFZCgkuXLs
Comment thread packages/keryx/package.json Outdated
{
"name": "keryx",
"version": "0.30.0",
"version": "0.30.1",

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The main characters package doesn't need a bump

This PR only touches the plugins, so the main package doesn't need a
bump.

https://claude.ai/code/session_017qp9Pn5f1J7LGFZCgkuXLs
@evantahler evantahler enabled auto-merge (squash) April 29, 2026 21:32
@evantahler evantahler merged commit 4f76a58 into main Apr 29, 2026
15 checks passed
@evantahler evantahler deleted the claude/add-plugin-readmes-Pl1Rj branch April 29, 2026 21:34
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.

2 participants