jasonwarrenuk/Docs: Readme
skills/doc-readme/SKILL.md
{{ ƔƔƔ }} Create or update a README — project root or any directory
$ install --global
skillsauthnpx skillsauth add jasonwarrenuk/goblin-mode Docs: ReadmeInstall 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: Jul 18, 2026, 7:16 AM127.8s1 file scanned
SKILL.md
- name:
- Docs: Readme
- description:
- {{ ƔƔƔ }} Create or update a README — project root or any directory
- when_to_use:
- When a project or directory has no README, or its existing one no longer matches the current structure or setup steps.
- model:
- sonnet
- disable-model-invocation:
- true
- allowed-tools:
- ["Read", "Glob", "Grep", "Write", "Edit", "Bash(git:*)", "Bash(~/.claude/library/scripts/git-doc-history.sh:*)"]
- arguments:
- ["mode", "target"]
- argument-hint:
- [create|update] [directory, default ./]
README create/update
Replaces the former doc-readme-create / doc-readme-create-sub / doc-readme-update trio: $mode picks the verb, $target picks the directory (project root when empty). If $mode is empty, infer it: README exists at the target → update; absent → create. Say which you inferred.
Mode: create
- Confirm the target directory exists; stop and report if not.
- Analyse it: purpose, contents, structure, key modules, build system, existing docs. For a sub-directory, read the surrounding context too (parent README, siblings, project docs) to place it in the codebase.
- Fill the matching skeleton —
~/.claude/library/templates/readme-root.mdfor the project root,readme-sub.mdfor a sub-directory. Each {{ slot }} describes its content; drop sections that do not apply, never invent content to fill one. - Include actual paths and commands, not placeholders. Match the style of existing project READMEs. Keep it proportional: a README is an overview, not full docs.
- Show the draft and stop for approval before writing. Back up an existing README first if one is present.
Mode: update
-
Resolve the README (
$target/README.md, default./README.md). If it does not exist, say so and offer create mode instead. -
Read it for structure and style, then gather what changed in one command:
"$HOME"/.claude/library/scripts/git-doc-history.sh $target/README.md $targetIt prints the commits, file changes and diff stat since the README was last touched — analyse that dump rather than running exploratory git calls.
-
Identify what needs updating: outdated descriptions, undocumented additions, removed content to clean up, structural changes.
-
Generate targeted updates preserving the existing structure and style; show a diff; apply on approval.
-
If the changes are minor, say so — don't invent updates for the sake of it. Prefer surgical edits over rewrites; don't remove content unless genuinely obsolete.
Related Skills
jasonwarrenuk/Roadmap: Build Zip
tools
VerifiedTrustedCommunity
{{ 𝚫𝚫𝚫 }} Rebuild roadmap-system.zip, the distributable snapshot of the roadmap tooling (scripts, HTML template, conventions reference, and every roadmap-touching skill, including this one).
5SKILL.mdUpdated Jul 21, 2026
jasonwarrenuk/skills/task-suggest
tools
VerifiedTrustedCommunity
--- name: "Suggest: Task" description: "{{ 𝚫𝚫𝚫 }} Suggest the next logical task — grounded in the roadmap's pre-vetted ready-set when one exists, codebase analysis otherwise" when_to_use: "When you don't know what to work on next and want a grounded recommendation rather than picking arbitrarily." model: haiku effort: low disable-model-invocation: true allowed-tools: ["Read", "Glob", "Grep", "Bash(python3:*)", "Bash(npm:*)", "Bash(bun:*)", "Bash(pnpm:*)", "Bash(deno:*)"] argument-hint: [named
5SKILL.mdUpdated Jul 17, 2026
jasonwarrenuk/Roadmap: Migrate
development
VerifiedTrustedCommunity
{{ 𝛀𝛀𝛀 }} Convert an old simple-style roadmap (single Markdown, four statuses, <a name> anchors, roadmaps.json pointer registry) into the rich phase-array format (roadmaps.json source of truth + PHASE task list + prose overview).
5SKILL.mdUpdated Jul 17, 2026
jasonwarrenuk/PR: Create
data-ai
VerifiedTrustedCommunity
{{ ƔƔƔ }} Create a pull request to main — wordy or shiny (with screenshots), ready-for-review or draft
5SKILL.mdUpdated Jul 17, 2026