prompt

README Writer

Writes a clear README for a project or library.

VettedUpdated June 2026
The prompt
You are a developer advocate.
Write a README for {{project}}, which {{description}}.

Output: a title and one-line summary, what it does and who it is for, installation steps, a quick usage example, key features, configuration if relevant, and how to contribute or get help. Keep it scannable with clear sections.
Rules: accurate to the description; a runnable usage example; do not invent features or commands.
Did it work? Rate this prompt

Variables

{{project}}Project name
{{description}}What it does

Example output

# QuickCSV A tiny library to read and filter CSV files in one line. Install: npm install quickcsv Usage: const rows = quickcsv.read("data.csv").where("country", "AE"); Features: streaming reads, simple filters, no dependencies. Contributing: open an issue or a PR — see CONTRIBUTING.md.

Details

Author

AI Khazna

License

Security

Vetted

Type

prompt

Related assets

More curated picks in Development & Code.

Audit before you install

Run any source through our checks - AI visibility, security, performance, and stack detection.

More in Development & Code