Skip to content

Commit 7e3f1c1

Browse files
authored
Merge pull request #94 from project-codeguard/update-readme-skills-terminology
2 parents f3d8456 + 01fceb1 commit 7e3f1c1

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Project CodeGuard: Security Rules for AI Coding Agents
1+
# Project CodeGuard: Security Skills and Rules for AI Coding Agents
22
![Securing](https://img.shields.io/badge/Securing%20AI%20Generated%20Code-green)
33
![Open Source](https://img.shields.io/badge/Now-Open%20Source-brightgreen)
44
[![License: CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)
@@ -22,14 +22,14 @@ Project CodeGuard solves this by embedding security best practices directly into
2222
**During and After Code Generation.**
2323

2424
Project CodeGuard is designed to integrate seamlessly across the entire AI coding lifecycle.
25-
- **Before code generation**, rules can be used for the design of a product and for spec-driven development. You can use the rules in the “planning phase” of an AI coding agent to steer models toward secure patterns from the start.
26-
- **During code generation**, rules can help AI agents to prevent security issues as code is being written.
25+
- **Before code generation**, skills and rules can be used for the design of a product and for spec-driven development. You can use the rules in the “planning phase” of an AI coding agent to steer models toward secure patterns from the start.
26+
- **During code generation**, skills and rules can help AI agents to prevent security issues as code is being written.
2727
- **After code generation**, AI agents like Cursor, GitHub Copilot, Codex, Windsurf, and Claude Code can use the rules for code review.
2828

2929

3030
## Security Coverage
3131

32-
Our rules cover essential security domains:
32+
Project CodeGuard skills and rules cover essential security domains:
3333

3434
- **Cryptography**: Safe algorithms (including post-quantum cryptography), secure key management, certificate validation
3535
- **Input Validation**: SQL injection prevention, XSS protection, command injection defense
@@ -44,19 +44,19 @@ Our rules cover essential security domains:
4444

4545
Get started in minutes:
4646

47-
1. **Download the rules** from our [releases page](https://github.com/project-codeguard/rules/releases)
48-
2. **Copy to your project** - Place AI agent and IDE specific rules in your repository
47+
1. **Download the skills and rules** from our [releases page](https://github.com/project-codeguard/rules/releases)
48+
2. **Copy to your project** - Place AI agent and IDE specific skills and rules in your repository
4949
3. **Start coding** - AI assistants will automatically follow security best practices
5050

5151
- Additional details in the [Get Started →](https://project-codeguard.org/getting-started/)
5252

5353

5454
## How It Works
5555

56-
1. **Security rules** are written in unified markdown format (`sources/` directory)
57-
2. **Conversion tools** translate rules to IDE-specific formats (Cursor, Windsurf, Copilot, Agent Skills, Antigravity)
58-
3. **Release automation** packages rules into downloadable ZIP files
59-
4. **AI assistants** reference these rules when generating or reviewing code
56+
1. **Security skills and rules** are written in unified markdown format (`sources/` directory)
57+
2. **Conversion tools** translate skills and rules to IDE-specific formats (Cursor, Windsurf, Copilot, Agent Skills, Antigravity)
58+
3. **Release automation** packages skills and rules into downloadable ZIP files
59+
4. **AI assistants** reference these skills and rules when generating or reviewing code
6060
5. **Secure code** is produced automatically without developer intervention
6161

6262
## Repository Structure
@@ -88,7 +88,7 @@ python src/convert_to_ide_formats.py # Generate skills/ and dist/
8888
- **🤝 Contributing**: [Learn how to contribute](https://github.com/project-codeguard/rules/blob/main/CONTRIBUTING.md)
8989

9090

91-
## 📄 Licensing
91+
## Licensing
9292

9393
This project uses dual licensing:
9494

@@ -98,4 +98,4 @@ This project uses dual licensing:
9898
This licensing approach ensures the security rules remain freely accessible and reusable while providing appropriate terms for software components.
9999

100100

101-
Copyright © 2025 Cisco Systems, Inc.
101+
Copyright © 2026 Cisco Systems, Inc.

0 commit comments

Comments
 (0)