readme-writing
Write, revise, or review README.md files, including project overviews, folder-level README files, setup orientation, navigation, and entrypoint documentation.
Skill by nvnunes
Install
Works with Claude Code, Claude apps, Codex, Cursor, Gemini CLI, GitHub Copilot, VS Code, OpenCode, Goose, Windsurf. Read the repository before you give any tool access to your data.
npx agentmarket install skill/nvnunes-readme-writing
Asks which of your tools to add it to (Claude Code, Codex, Cursor, VS Code, Windsurf, Gemini CLI, Claude Desktop) and shows the change first. See https://agentmart.dev/cli.
Get the weekly diff
The weekly diff: one email a week with new agent tools, notable updates and grade changes, plus security alerts for tools you follow. Double opt-in, one-click unsubscribe.
About
Use cases: writing
Reviews
Write a reviewNo reviews yet. Installed it? Reviews come from verified installers only. How reviews work
Permissions
What this skill can do and what it asks for, from its SKILL.md. Checked Oct 25, 2026.
- Tools
- No tools found
- Secrets
- None asked for
- Install scripts
- None found
Network hosts it talks to 1
codeload.github.com· found in install command
Files it touches
~/.claude/skills/readme-writing
What's inside
- Skill name
readme-writing- Description
- Write, revise, or review README.md files, including project overviews, folder-level README files, setup orientation, navigation, and entrypoint documentation. Use when the target file is a README, not general docs, plans, or prompts.
- License
- MIT
- Instructions
- 9 lines in SKILL.md · view on GitHub
Files (3)
- SKILL.md
- openai.yaml · agents/
- readme-md.md · references/
SKILL.md (first lines)
# README Writing Use this skill for `README.md` and folder-level README files. Pair with `$technical-writing`, then read `references/readme-md.md`. Pair with `$project-docs-writing` only when the README needs source-of-truth or documentation-surface judgment. Keep README files oriented toward fast human entry: what this is, when to use it, where to go next, and which docs own durable details. Avoid turning a README into the full source of truth when a narrower doc owns the detail.
From nvnunes/astro-agents, MIT.
More from nvnunes/astro-agents
- 0.570score
research-logging
nvnunes
Perform, record, reproduce, review, and validate investigations in project-native research logs by implementing and running scripts, retaining and analyzing…
SkillAFreshness: AClaude Code +9 - 0.561score
code-quality-review
nvnunes
Review source-code quality, architecture, ownership, contracts, lifecycle clarity, public API boundaries, tests, validation behavior, abstractions, and…
SkillAFreshness: AClaude Code +9 - 0.529score
plan-execution
nvnunes
Implement or resume work governed by an existing plan, coordinate explicitly authorized delegated Tasks for named plan files, maintain progress, perform…
SkillBFreshness: BClaude Code +9 - 0.526score
agent-surface-review
nvnunes
Review agent surfaces, AGENTS.md files, SKILL.md files, prompt files, instruction scope, workflow behavior, documentation-surface integration, and validation…
SkillBFreshness: BClaude Code +9 - 0.524score
plan-writing
nvnunes
Write, develop, shard, revise, or review implementation plans, roadmaps, migration plans, sequencing documents, and explicit delegated Task assignments.
SkillBFreshness: BClaude Code +9 - 0.521score
skill-md-writing
nvnunes
Write, revise, or review SKILL.md files and skill packages, including frontmatter descriptions, selection boundaries, progressive-disclosure references…
SkillBFreshness: BClaude Code +9 - 0.521score
project-upgrade-planning
nvnunes
Assess project upgrade readiness against the shared astro-agents upgrade model and plan upgrade grouping, sequencing, documentation profile choices…
SkillBFreshness: BClaude Code +9 - 0.521score
documentation-surface-review
nvnunes
Review documentation surfaces, documentation surface profiles, source-of-truth docs, README scope, public Python docs, private/default docs, and documentation…
SkillBFreshness: BClaude Code +9 - 0.521score
python-code-writing
nvnunes
Write, edit, or refactor Python source code, including APIs, lifecycle clarity, contracts, tests, docstrings, package structure, and project-local Python…
SkillBFreshness: BClaude Code +9 - 0.479score
pubify-authoring
nvnunes
Work on pubify-pubs and pubify-ppt publication and presentation workflows, including pubs and ppt CLI behavior, pubify.yaml workspaces, configured publication…
SkillCFreshness: CClaude Code +9 - 0.474score
science-writing
nvnunes
Write, revise, or review scientific prose for papers, theses, conference material, research proposals, technical analysis, claims, evidence, methods, results…
SkillCFreshness: CClaude Code +9 - 0.474score
technical-writing
nvnunes
Write, revise, or review general technical prose using shared discipline for clarity, structure, audience fit, scope control, and restrained style.
SkillCFreshness: CClaude Code +9
Signals
- Stars
- 0
- Forks
- 0
- Open issues
- 0
- Last commit (this folder)
- Apr 30, 2026 (6 months ago)
From GitHub (fetched Oct 24, 2026).
Details
- License
- MIT
- Repository
- github.com/nvnunes/astro-agents
- First seen
- Oct 24, 2026
- Last checked
- Oct 24, 2026
- Source
- GitHubgithub-graphql
More from nvnunes
- 0.570score
research-logging
nvnunes
Perform, record, reproduce, review, and validate investigations in project-native research logs by implementing and running scripts, retaining and analyzing…
SkillAFreshness: AClaude Code +9 - 0.561score
code-quality-review
nvnunes
Review source-code quality, architecture, ownership, contracts, lifecycle clarity, public API boundaries, tests, validation behavior, abstractions, and…
SkillAFreshness: AClaude Code +9 - 0.529score
plan-execution
nvnunes
Implement or resume work governed by an existing plan, coordinate explicitly authorized delegated Tasks for named plan files, maintain progress, perform…
SkillBFreshness: BClaude Code +9 - 0.526score
agent-surface-review
nvnunes
Review agent surfaces, AGENTS.md files, SKILL.md files, prompt files, instruction scope, workflow behavior, documentation-surface integration, and validation…
SkillBFreshness: BClaude Code +9 - 0.524score
plan-writing
nvnunes
Write, develop, shard, revise, or review implementation plans, roadmaps, migration plans, sequencing documents, and explicit delegated Task assignments.
SkillBFreshness: BClaude Code +9 - 0.521score
project-upgrade-planning
nvnunes
Assess project upgrade readiness against the shared astro-agents upgrade model and plan upgrade grouping, sequencing, documentation profile choices…
SkillBFreshness: BClaude Code +9
Cite this page
readme-writing skill. Agent Mart. https://agentmart.dev/skills/nvnunes-readme-writing (last updated 2026-10-24)