qte77/writing-readme
plugins/readme-generator/skills/writing-readme/SKILL.md
Generate or update README.md files across three scopes — repo (with project-type detection), account (GitHub user profile), and org (organization profile). Use when creating, updating, or aligning a README to org conventions.
$ install --global
skillsauthnpx skillsauth add qte77/claude-code-utils writing-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: Jun 22, 2026, 4:14 AM47.4s2 files scanned
SKILL.md
- name:
- writing-readme
- description:
- Generate or update README.md files across three scopes — repo (with project-type detection), account (GitHub user profile), and org (organization profile). Use when creating, updating, or aligning a README to org conventions.
- compatibility:
- Designed for Claude Code
- argument-hint:
- <scope> [target]
- allowed-tools:
- Read, Grep, Glob, Edit, Write, Bash, WebFetch, Agent
Write README
Scope: $ARGUMENTS
Generate or update a README.md following scope-specific best practices.
Phase 1: Detect Scope
Parse $ARGUMENTS to determine scope:
repo(default) — README.md for a code repository in the current directoryrepo <owner/repo>— README.md for a specific remote repositoryaccount <username>— profile README for a GitHub user (<username>/<username>/README.md)org <orgname>— organization profile README (.github/profile/README.md)
If no scope is given, default to repo for the current working directory.
Phase 2: Gather Context
For repo
- Read existing README.md (if any)
- Detect project type:
action.yml/action.yamlexists → GitHub Actionpyproject.toml/setup.py→ Python librarypackage.json→ Node.js/TypeScriptCargo.toml→ Rustgo.mod→ Go
- Read project manifest for name, version, description, license
- Scan source tree:
src/,lib/, main entry points - Read LICENSE file
- Check for existing docs: CONTRIBUTING.md, AGENTS.md, docs/
For account
gh api users/<username>— bio, company, location, bloggh repo list <username> --limit 30 --json name,description,stargazerCount,primaryLanguage— repos sorted by stars- Read existing
<username>/<username>/README.mdif it exists - Identify top 3-5 repos by stars or recent activity
For org
gh api orgs/<orgname>— description, blog, locationgh repo list <orgname> --limit 50 --json name,description,isPrivate,stargazerCount,primaryLanguage— public repos- Read existing
.github/profile/README.mdor.github/readme.md - Group repos by domain/purpose
- Identify pinned repos if any
Phase 3: Apply Template
See references/readme-templates.md for the four template snippets and per-scope conventions (GitHub Action, Library/Application, Account, Organization). Repo READMEs follow the qte77 doc-structure canon: value-first order Hero → Badges → What → How → Why → Refs → License → tail; badges License → Version → CI (static blue / native status, Version linked to CHANGELOG.md).
Pick the template matching the scope detected in Phase 1 and the project type detected in Phase 2.
Phase 4: Generate
- Draft the README applying the appropriate template
- Verify all links resolve
- Present the draft to the user for review
- Write the file after user approval
Rules
- Never add content the project doesn't have
- Keep descriptions factual — pull from existing docs, manifests, and code
- Don't add emojis unless the user requests them
- Prefer brevity — every sentence should earn its place
- For org READMEs: omit private repos unless the user explicitly asks
- License file is always
LICENSE(neverLICENSE.md) - Repo READMEs derive from the qte77 doc-structure canon — never invent a divergent structure
Related Skills
qte77/triaging-security-report
development
VerifiedTrustedCommunity
Verify an external or AI-generated security report against the actual codebase before acting on it. Use when handed a scanner PDF, automated teardown, audit report, or bug-bounty submission — classifies every finding CONFIRMED / OVERSTATED / FALSE-POSITIVE / FABRICATED and salvages the real work items.
2SKILL.mdUpdated Jul 18, 2026
qte77/auditing-website-seo-geo
development
VerifiedTrustedCommunity
Audits a site's SEO and AI-search (GEO) readiness — meta tags, Open Graph/Twitter, JSON-LD, robots/llms conventions — and generates fixes. Use when reviewing search visibility, social previews, structured data, or LLM/AI-crawler discoverability.
1SKILL.mdUpdated Jun 14, 2026
qte77/researching-website-design
development
VerifiedTrustedCommunity
Analyzes industry websites for design patterns, layout, typography, and content strategies using first-principles thinking. Use when researching website design, UI patterns, or competitive design analysis.
1SKILL.mdUpdated Apr 19, 2026
qte77/auditing-website-usability
development
VerifiedTrustedCommunity
Audits website usability for UX optimization, covering forms, navigation, validation, and microcopy. Use when reviewing user experience, task completion flows, or interface friction points.
1SKILL.mdUpdated Apr 19, 2026