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/healthcare-admin
tools
VerifiedTrustedCommunity
Use when a task involves healthcare administration: revenue cycle management, HIPAA/compliance auditing, medical coding (ICD-10, CPT, DRGs), CMS cost reports, payer contract analysis, quality improvement, clinical operations, health IT/interoperability, population health, or pharmacy benefits.
19SKILL.mdUpdated Jun 29, 2026
jshsakura/first-principles-thinking
testing
VerifiedTrustedCommunity
Use when a task needs assumptions challenged, a complex problem broken down to fundamentals, or a solution rebuilt from scratch rather than from convention or analogy.
19SKILL.mdUpdated Jun 29, 2026
jshsakura/design-bridge
testing
VerifiedTrustedCommunity
Use when a task needs a DESIGN.md (e.g. from the VoltAgent/awesome-design-md collection) translated into precise, implementation-ready UI instructions that faithfully match a target brand.
19SKILL.mdUpdated Jun 29, 2026
jshsakura/cohort-analysis
research
VerifiedTrustedCommunity
Use when a task needs retention analysis, cohort behavior comparison, activation-metric discovery, or diagnosis of how user groups perform over time.
19SKILL.mdUpdated Jun 29, 2026