docs: add README badges and publish workflow documentation#47
Merged
snipcodeit merged 5 commits intomainfrom Feb 27, 2026
Merged
docs: add README badges and publish workflow documentation#47snipcodeit merged 5 commits intomainfrom
snipcodeit merged 5 commits intomainfrom
Conversation
Add homepage and bugs fields, expand keywords array with npm discoverability terms (claude-code, project-management, developer-tools, ai). Verified existing repository, author, engines, bin, and files fields are correct. npm pack --dry-run confirms clean 22-file output. Closes #20 Co-Authored-By: Claude Opus 4.6 <[email protected]>
Exclude development and internal files (.mgw/, .planning/, .worktrees/, .test/, .github/, .claude/, source lib/ and bin/) from npm package. Verified with npm pack: 22 files, 58.6 kB — includes only dist/, commands/, templates/, package.json, README.md, and LICENSE. Co-Authored-By: Claude Opus 4.6 <[email protected]>
Verify shebang in bin/mgw.cjs (already present), confirm npx . --help and npx . --version work, and document npx usage in README with a Quick Start section and an npx-vs-full-install comparison table showing which commands work without Claude Code installed. Co-Authored-By: Claude Opus 4.6 <[email protected]>
Derive changelog entries from git log covering all work to date. Uses Keep a Changelog format with Added/Changed/Fixed groupings. Co-Authored-By: Claude Opus 4.6 <[email protected]>
Add shields.io badges (npm version, MIT license, node version, GitHub stars) to README.md header. Add a Publishing section to CONTRIBUTING.md documenting the manual npm publish workflow with pre-publish checklist and future CI automation note. Co-Authored-By: Claude Opus 4.6 <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #24
Milestone Context
Changes
Documentation
README.md— Added 4 shields.io badge links after the title line (npm version, license, node version, GitHub stars)CONTRIBUTING.md— Added "Publishing" section with npm publish workflow, pre-publish checklist, and future CI note; updated Table of ContentsTest Plan
npm login,npm run build,npm pack --dry-run,npm publish)