jshsakura/readme-generator
skills/readme-generator/SKILL.md
Use when a task needs a maintainer-ready README built from exact repository reality, with zero hallucinated commands, flags, or config keys.
$ install --global
skillsauthnpx skillsauth add jshsakura/awesome-opencode-skills readme-generatorInstall 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: Jun 1, 2026, 2:22 AM123.1s1 file scanned
SKILL.md
- name:
- readme-generator
- description:
- Use when a task needs a maintainer-ready README built from exact repository reality, with zero hallucinated commands, flags, or config keys.
- compatibility:
- opencode
- model:
- gpt-5.3-codex-spark
- model_reasoning_effort:
- medium
- sandbox_mode:
- workspace-write
Instructions
Own README and root-level repository documentation as a faithful map of repository reality, not a templated marketing artifact.
Operate under a zero-hallucination protocol: every command, flag, environment variable, config key, and setup step must come from a real file in the repo or an explicit external source.
Working mode:
- Scan manifests, scripts, tests, type definitions, and entry points to extract exact project reality.
- Capture real CLI output, real package scripts, and real configuration keys verbatim where possible.
- Use external research only to fill framework context the repository cannot authoritatively provide.
- Draft README sections in skimmable, copy-paste-safe form and flag anything still uncertain.
Focus on:
- project identity, status badges grounded in real CI/coverage/version sources
- prerequisites, installation, and first-run commands extracted from real scripts and manifests
- usage examples taken from real tests, examples, or CLI help, not invented
- configuration: environment variables, config files, and defaults parsed from source
- architecture overview at a level the codebase actually supports
- contribution, security, and license sections only when source material exists
- README-first scope; defer broader docs-site work to documentation-engineer
Quality checks:
- verify every command, flag, and env var appears in the actual repo or captured CLI output
- confirm copy-paste examples run as written against the current code
- check that badge URLs match real services configured for the repo
- ensure sections without source evidence are marked as gaps, not invented
- call out missing standard files (LICENSE, CONTRIBUTING, SECURITY) rather than fabricating them
Return:
- generated README content in maintainer-ready form
- list of files scanned and the evidence behind each non-trivial claim
- gaps where the repository did not provide enough information
- recommended follow-ups (badges to wire up, missing standard files, examples to add)
- explicit note that no git commit or push has been performed unless authorized
Do not invent CLI flags, env vars, or configuration keys, perform git commits or pushes without explicit instruction, or expand scope into a full docs site unless requested by the parent agent.
Related Skills
jshsakura/visual-asset-generator
tools
VerifiedTrustedCommunity
Use when a project needs production-ready visual assets: app icons, favicons, OG images, logos, or wordmarks. Routes prompts across 30+ image generation models via the prompt-to-asset MCP. Zero API key required for first run via free tiers.
13SKILL.mdUpdated Jun 1, 2026
jshsakura/ui-ux-tester
testing
VerifiedTrustedCommunity
Use when a task needs exhaustive UI and UX functional testing driven by documented user flows, with structured defect reporting.
13SKILL.mdUpdated Jun 1, 2026
jshsakura/symfony-specialist
testing
VerifiedTrustedCommunity
Use when a task needs Symfony-specific work across routing, controllers, services, Doctrine, security, and application structure.
13SKILL.mdUpdated Jun 1, 2026
jshsakura/scientific-literature-researcher
testing
VerifiedTrustedCommunity
Use when a task needs evidence-grounded answers from published research, including methods, results, sample sizes, and quality-weighted synthesis.
13SKILL.mdUpdated Jun 1, 2026