fai-readme-generator — independently scanned and version-tracked by SaferSkills.
SaferSkills independently audited fai-readme-generator (Agent Skill) and scored it 100/100 (green). The audit ran 55 deterministic rules across Security, Supply Chain, Maintenance, Transparency, and Community; it found 0 high-severity and 0 lower-severity findings. The full rule-by-rule trace and per-finding evidence are below. Free, methodology-open.
Findings & checks · 0 flagged
Every scanned point with the score it earned and what moved between them.
First recorded scan — no prior version to compare against.
The primary manifest — the file an agent reads to learn what this artifact does.
Create comprehensive README files with badges, quickstart, and architecture docs.
# Project Name
[](https://github.com/org/repo/actions)
[](https://codecov.io/gh/org/repo)
[](https://npmjs.com/package/package-name)
> One-line description of what this project does.
## Quick Start
\```bash
# Install
npm install package-name
# Run
npx package-name --help
\```
## Features
- **Feature 1** — Description
- **Feature 2** — Description
- **Feature 3** — Description
## Architecture
\```
[Client] → [API Gateway] → [Azure OpenAI]
→ [AI Search]
→ [Cosmos DB]
\```
## Usage
\```python
from package import Client
client = Client()
result = client.search("query")
print(result)
\```
## Configuration
| Variable | Default | Description |
|----------|---------|-------------|
| AZURE_OPENAI_ENDPOINT | — | Azure OpenAI endpoint URL |
| MODEL | gpt-4o-mini | Default model |
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
## License
[MIT](LICENSE)def generate_badges(repo: str, package: str = None) -> str:
badges = [
f"[]"
f"(https://github.com/{repo}/actions)",
]
if package:
badges.append(f"[]"
f"(https://npmjs.com/package/{package})")
return " ".join(badges)| Issue | Cause | Fix |
|---|---|---|
| README too long | Including implementation details | Keep to WHAT and HOW to use, not internals |
| Badges broken | Wrong repo or branch name | Verify badge URLs point to correct repo |
| Quickstart doesn't work | Missing prerequisites | List all prerequisites before commands |
| No architecture section | "Too complex to draw" | Use simple text diagram — even 3 boxes helps |
~30 seconds. Free. No account. Every finding cites a rule and a line of evidence.