write-readme

How to write a clear, accurate README.md for a project.

IndexedMIT

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/streamingboss-write-readme

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

How to write a clear, accurate README.md for a project. Use when the user asks to create, write or improve a README.

Use cases: writing

Reviews

Write a review

No 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/write-readme

What's inside

Skill name: write-readme
Description: How to write a clear, accurate README.md for a project. Use when the user asks to create, write or improve a README.
License: MIT
Instructions: 14 lines in SKILL.md · view on GitHub

Files (1)

SKILL.md

SKILL.md (first lines)

# Writing a README

1. Look at the project first: list_files, then read_file on the main source files and any
   existing README.md. Only describe what the code actually does.
2. If you can, run the main program with run_command to see its real output.
3. Write README.md with these sections, in this order:
   - `# <Project name>` and one or two sentences: what it is and what it's for.
   - `## Requirements`: language version and dependencies (look for requirements.txt or imports).
   - `## How to run`: the exact command(s), in a code block.
   - `## Example`: a real command and the output it produces.
4. Keep it short: no badges, no invented features, no "coming soon" sections.
5. If README.md already exists, change it with edit_file instead of rewriting it, and keep any
   accurate content.

From StreamingBoss/myharness, MIT.

Signals

Stars: 0
Forks: 0
Open issues: 0
Last commit (this folder): Oct 4, 2026 (24 days ago)

From GitHub (fetched Oct 24, 2026).

Details

License: MIT
Repository: github.com/StreamingBoss/myharness
First seen: Oct 24, 2026
Last checked: Oct 24, 2026
Source: GitHub github-graphql