Update README

[yu-iskw]

PR Type

Documentation

---

Description

• Add installation instructions with npm and npx options

• Improve command documentation with concrete examples

• Add packages table with links and descriptions

• Update roadmap to reflect completed features

• Enhance CONTRIBUTING.md with package names

---

Diagram Walkthrough

flowchart LR
  A["README.md"] -->|"Add installation section"| B["Installation guide"]
  A -->|"Enhance commands"| C["Command examples"]
  A -->|"Add packages table"| D["Package references"]
  A -->|"Update roadmap"| E["Completed items marked"]
  F["CONTRIBUTING.md"] -->|"Add package names"| G["Package identifiers"]

Loading

File Walkthrough

Relevant files

Documentation

README.md Add installation guide and package documentation                  README.md Add new Installation section with npm and npx instructions Enhance command examples with concrete arguments (owner/repo, rule-name, etc.) Capitalize section headers (Rules, Skills, Subagents, Plugins, System) Add Packages section with table listing all ecosystem packages and links Update Roadmap to mark Hooks Plugin and MCP Plugin as completed +43/-15  CONTRIBUTING.md Add npm package names to package descriptions                        CONTRIBUTING.md Update package descriptions to include npm package names Add package identifiers for cli, common, core, and plugin-api Add package identifiers for claude-code-hooks, cursor-hooks, and mcp plugins Improve clarity with consistent formatting and naming conventions +7/-7

---

[qodo-code-review]

ⓘ You are approaching your monthly quota for Qodo. Upgrade your plan

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢	No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
⚪	🎫 No ticket provided Create ticket/issue
Codebase Duplication Compliance
⚪	Codebase context is not defined Follow the guide to enable codebase context checks.
Custom Compliance
🟢	Generic: Comprehensive Audit Trails Objective: To create a detailed and reliable record of critical system actions for security analysis and compliance. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Meaningful Naming and Self-Documenting Code Objective: Ensure all identifiers clearly express their purpose and intent, making code self-documenting Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Robust Error Handling and Edge Case Management Objective: Ensure comprehensive error handling that provides meaningful context and graceful degradation Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Error Handling Objective: To prevent the leakage of sensitive system information through error messages while providing sufficient detail for internal debugging. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Logging Practices Objective: To ensure logs are useful for debugging and auditing without exposing sensitive information like PII, PHI, or cardholder data. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Security-First Input Validation and Data Handling Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent vulnerabilities Status: Passed Learn more about managing compliance generic rules or creating your own custom rules

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

[qodo-code-review]

ⓘ You are approaching your monthly quota for Qodo. Upgrade your plan

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Possible issue	Correct misleading plugin installation example Update the caf plugin add example to avoid implying that installation from a repository is supported, as this contradicts the roadmap which lists remote installation as a future feature. README.md [86-87] # Install a third-party plugin -caf plugin add owner/repo +caf plugin add <plugin-package-name> Apply / Chat Suggestion importance[1-10]: 8 __ Why: The suggestion correctly identifies a significant contradiction in the documentation introduced by this PR, where an example command implies a feature is available while the roadmap explicitly states it is not yet implemented.	Medium
More