Skip to content

Docs: Update README for hook installation #5

@ProduktEntdecker

Description

@ProduktEntdecker

Overview

Update README to reflect the new hook-based architecture.

Depends On

Acceptance Criteria

  • Remove MCP server installation instructions
  • Add Claude Code hook installation instructions
  • Show example settings.json configuration
  • Explain what happens when vulnerabilities are found
  • Add troubleshooting section
  • Update project description ("Security hook for vibe coders")

New Installation Section

// ~/.claude/settings.json
{
  "hooks": {
    "PreToolUse": [{
      "matcher": "Bash",
      "hooks": [{
        "type": "command",
        "command": "npx patchpilot",
        "timeout": 10
      }]
    }]
  }
}

Priority: P2

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions