Readme polish

Skill contextosai/skills/skills/readme-polish

A collection of Agent Skills — self-contained folders that teach AI agents to perform specialized tasks. Includes a production-readiness harness-audit skill, a plugin marketplace, a SKILL.md spec, and CI validation.

Install

npx -y skills add contextosai/skills --skill readme-polish

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

1 stars1 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

Improve a project's README for clarity, structure, and completeness without changing its meaning. Use when the user asks to clean up, polish, or improve a README or project documentation.

SKILL.md

1.3 KB, as published. Nobody here has run it

README Polish

Improve an existing README's clarity and structure while preserving its intent.

Steps

Read the current README in full before changing anything.
Check that it answers the questions a new reader asks, in order:
- What is this project and who is it for?
- How do I install it?
- How do I use it (a minimal, copy-pasteable example)?
- How do I configure it?
- How do I contribute / where do I get help?
Restructure and tighten the prose. Do not invent features, commands, or claims that aren't supported by the project.

Suggested structure

# Project Name
One-line description.

## Installation
## Usage
## Configuration
## Contributing
## License

Guidelines

Preserve technical accuracy above all — when unsure whether a command or claim is correct, flag it for the user instead of guessing.
Prefer a short, working example over a long prose explanation.
Keep headings shallow and scannable; use code fences for all commands.
Don't pad. Every section should earn its place.