vibe-shield 1.0.0 → 1.2.0

package/README.md

@@ -38,6 +38,56 @@ Paste this output to Cursor or Claude Code and it will fix the issues for you.
 
 Run `npx vibe-shield init` to create a `.cursorrules` file that reminds your AI agent to run security checks before completing tasks.
 
+Or manually add this rule to your AI tool (Claude Code, Cursor, Antigravity, etc.):
+
+```
+# Vibe Shield Security Rules
+
+Before marking a task as done, run `npx vibe-shield`. If issues are found, follow the [INSTRUCTION] provided in the output to fix them.
+
+## Security Checklist
+- [ ] No hardcoded secrets (API keys, passwords, tokens)
+- [ ] No dangerous code execution (eval, shell injection)
+- [ ] No SQL injection vulnerabilities (use parameterized queries)
+- [ ] All secrets stored in environment variables
+- [ ] HTTPS used for all external URLs
+```
+
+## Pre-commit hook
+
+Block commits that have security issues:
+
+```bash
+npx vibe-shield hook            # Install
+npx vibe-shield hook --uninstall  # Remove
+```
+
+The hook scans staged files before each commit. Bypass with `git commit --no-verify`.
+
+## MCP Server
+
+vibe-shield can run as an MCP server, allowing AI tools to call it directly.
+
+Add to your MCP config (Claude Desktop, Cursor, Antigravity, etc.):
+
+```json
+{
+  "mcpServers": {
+    "vibe-shield": {
+      "command": "npx",
+      "args": ["vibe-shield", "mcp"]
+    }
+  }
+}
+```
+
+Config file locations:
+- **Claude Desktop**: `~/Library/Application Support/Claude/claude_desktop_config.json`
+- **Cursor**: `.cursor/mcp.json` in your project
+- **Antigravity**: `~/.gemini/antigravity/mcp_config.json`
+
+After setup, your AI assistant can use the `vibe_shield_scan` tool to check for security issues.
+
 ## Development
 
 ```bash
@@ -49,3 +99,4 @@ bun run build
 ## License
 
 MIT
+