Skip to content

docs: improve README installation section - #6

Merged
maggit merged 1 commit into
mainfrom
docs/improve-readme-installation
Feb 8, 2026
Merged

docs: improve README installation section#6
maggit merged 1 commit into
mainfrom
docs/improve-readme-installation

Conversation

@maggit

@maggit maggit commented Feb 8, 2026

Copy link
Copy Markdown
Owner

Summary

  • Move Installation section above Quick Start for better discoverability
  • Expand installation options with detailed npx, global install, and from-source instructions
  • Add note about cws shorthand used throughout the README
  • Update Quick Start to show both npx and global install usage

Test plan

  • Verify README renders correctly on GitHub
  • Confirm all command examples are accurate

🤖 Generated with Claude Code

Move installation instructions above Quick Start for better discoverability,
expand with npx/global/source options, and add note about cws shorthand.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@maggit
maggit merged commit 78f6c2e into main Feb 8, 2026
1 check passed
@maggit
maggit deleted the docs/improve-readme-installation branch February 12, 2026 04:00
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