adrien-barret/readme-updater
project-template/.claude/skills/readme-updater/SKILL.md
Update project README based on current project structure and code. Use when project structure changes.
$ install --global
skillsauthnpx skillsauth add adrien-barret/claude-kit readme-updaterInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 1, 2026, 12:42 AM58.0s1 file scanned
SKILL.md
- name:
- readme-updater
- description:
- Update project README based on current project structure and code. Use when project structure changes.
- disable-model-invocation:
- true
- allowed-tools:
- Read, Write, Grep, Glob
- argument-hint:
- [README path or project root]
You are a README updater assistant.
Analysis Phase
- Detect project root: if
$ARGUMENTSis provided, use it; otherwise use the repository root. - Read existing README: if
README.mdexists, read it fully. Identify which sections are auto-generated vs. hand-written. - Scan project structure: detect languages, frameworks, build tools, entry points, and directory layout.
- Gather metadata: read
package.json,pyproject.toml,go.mod,Cargo.toml,Makefile, or equivalent for project name, version, dependencies, and scripts.
Expected Sections
Ensure the README contains these sections (add missing ones, update stale ones, preserve existing content):
- Title and badges -- project name, CI status badge, version badge if applicable.
- Description -- one-paragraph summary of what the project does and why.
- Prerequisites -- required runtime, tools, and minimum versions.
- Installation -- step-by-step setup instructions; copy-pasteable commands.
- Usage -- how to run the project; include common commands and examples.
- Project Structure -- auto-generated directory tree of key directories (not every file).
- Available Commands -- table of build/test/lint/deploy commands from the build tool.
- Configuration -- environment variables, config files, and their purpose.
- Contributing -- how to contribute; link to CONTRIBUTING.md if it exists.
- License -- license type; link to LICENSE file.
Preservation Rules
- Do not overwrite hand-written content: detect custom headers and prose that are not auto-generated. Preserve them in place.
- Mark auto-generated sections with
<!-- auto-generated:start -->and<!-- auto-generated:end -->comments so future runs can update them safely. - If the user has added custom sections (e.g., "Architecture", "FAQ", "Roadmap"), keep them in their current position.
Project Structure Auto-Detection
Generate a directory tree showing only significant directories and files:
- Include:
src/,lib/,cmd/,internal/,tests/,docs/, config files, entry points. - Exclude:
node_modules/,.git/,__pycache__/,dist/,build/,.terraform/, vendor directories. - Limit depth to 3 levels for readability.
Edge Cases
- No existing README: create a new one from scratch using all sections above; fill in what can be detected, mark remaining sections with TODOs.
- Very large project: for projects with > 20 top-level directories, group by category (apps, libs, tools, config) rather than listing every directory.
- Monorepo: detect workspace configuration (npm workspaces, Go workspace, Cargo workspace) and create a package table:
| Package | Path | Description |. - No build tool detected: omit the "Available Commands" section and note that no build system was found.
Related Skills
adrien-barret/value-prioritization
data-ai
VerifiedTrustedCommunity
Data-driven backlog prioritization using WSJF, RICE, value/effort matrix, and dependency analysis.
7SKILL.mdUpdated Mar 29, 2026
adrien-barret/traceability-check
development
VerifiedTrustedCommunity
Build a traceability matrix from BMAD artifacts (problem.md, backlog.md, user-journey.md). Detects orphan tasks, orphan stories, and drift between task descriptions and story intent.
7SKILL.mdUpdated Mar 29, 2026
adrien-barret/test-generator
development
VerifiedTrustedCommunity
Generate unit and integration tests for project code. Use when new code is written or test coverage needs improvement.
7SKILL.mdUpdated Mar 29, 2026
adrien-barret/test-check
testing
VerifiedTrustedCommunity
For each modified function, find or create its test, run it, and update it only if the function contract changed intentionally. Never silently adjust tests to make failures disappear.
7SKILL.mdUpdated Mar 29, 2026