docs(#286): improve README and add complete CLI command reference#293
Merged
docs(#286): improve README and add complete CLI command reference#293
Conversation
Restructure both English and Japanese READMEs to serve as effective GitHub landing pages, following 11 improvement points from Issue #286. Key changes: - Add badges (npm version, downloads, license, CI) - Consolidate catchphrase to single line with 3 benefit bullet points - Add "Who is this for?" and "What makes it unique?" sections - Compress Quick Start to 3 copy-paste steps - Add Troubleshooting section (CLI path, port, tmux session inspection) - Add Mermaid architecture diagram (How it works) - Add Use Cases section (commute, childcare, parallel dev) - Reorganize Security section with recommended/prohibited configurations - Reorganize FAQ (move items to relevant sections) - Add screenshots in <details> fold, manual TOC, Status: Beta - Add tmux session naming convention and direct inspection commands - Fix broken security-guide.md link path - Add Gemini CLI to supported tools list Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Expand CLI Commands section from 6 to 30+ commands organized by category: - Basic: init/start/stop/status with all options (--force, --dev, etc.) - Worktree: --issue and --auto-port for parallel development - GitHub Issue: create/search/list with template options (requires gh CLI) - Documentation: docs command with --section/--search/--all Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add --question, --title, --body, --labels options for issue create command in both English and Japanese README. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
issue createの不足オプション（--question,--title,--body,--labels）を追記Changed Files
README.md- English README overhaul + CLI referencedocs/ja/README.md- Japanese README overhaul + CLI referenceNotes
Test plan
🤖 Generated with Claude Code