Skip to content

Update the README.md with Plugin Information for Claude Code #43

@santosomar

Description

@santosomar

Update the README.md with something like the text below (once #42 is completed)

Plugin for Claude Code

Project CodeGuard is available as a Claude Code plugin for easy integration with AI coding workflows.

Quick Install

# Add Project CodeGuard marketplace
/plugin marketplace add project-codeguard/rules

# Install the security skill
/plugin install codeguard-security@project-codeguard

Manual Installation

Alternatively, clone the repository and add as a local marketplace:

git clone https://github.com/project-codeguard/rules.git
cd /path/to/claude-project
/plugin marketplace add /path/to/project-codeguard/rules
/plugin install codeguard-security@project-codeguard

Team Installation

For teams, add to your repository's .claude/settings.json:

{
  "marketplaces": [
    {
      "source": "project-codeguard/rules"
    }
  ],
  "plugins": [
    {
      "name": "codeguard-security",
      "marketplace": "project-codeguard",
      "enabled": true
    }
  ]
}

Usage

Once installed, the CodeGuard security skill automatically activates when writing or reviewing code. Claude will:

  • ✓ Check for hardcoded credentials (always)
  • ✓ Apply context-specific security rules based on language and feature
  • ✓ Suggest secure coding patterns
  • ✓ Prevent common vulnerabilities

For detailed plugin documentation, see docs/CLAUDE_CODE_PLUGIN.md

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions