Skip to content

docs: add README.md for security-guidance plugin#53203

Open
gugli4ifenix-design wants to merge 1 commit intoanthropics:mainfrom
gugli4ifenix-design:docs/security-guidance-readme
Open

docs: add README.md for security-guidance plugin#53203
gugli4ifenix-design wants to merge 1 commit intoanthropics:mainfrom
gugli4ifenix-design:docs/security-guidance-readme

Conversation

@gugli4ifenix-design
Copy link
Copy Markdown

Summary

The security-guidance plugin is the only plugin in the /plugins directory without a README. This PR adds one.

Changes

  • Added plugins/security-guidance/README.md with:
    • Overview of the PreToolUse hook
    • Table of all 9 security patterns monitored
    • How the hook works (detection, blocking, session dedup)
    • Configuration via ENABLE_SECURITY_REMINDER env var
    • Installation instructions

Why

Every other plugin has a README — this one was missing. The README helps users understand what patterns are checked and how to configure the hook before installing.

The security-guidance plugin was the only plugin in the directory
missing a README. This adds documentation covering:

- Overview of the PreToolUse hook
- Table of all 9 security patterns monitored
- How the hook works (detection, blocking, dedup)
- Configuration (ENABLE_SECURITY_REMINDER env var)
- Installation instructions
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