Recipe

Open-source project README writer

Generate a polished, community-ready README.md from a brief description of your project. Meridian structures badges, installation steps, usage examples, and contribution guidelines so maintainers can ship faster.

Prompt template

Write a README.md for an open-source project called [name].
Stack: [languages/frameworks].
Key features: [bullet list].
Include badges, quick-start, API overview, and contributing section.

Badges

Shields.io build, license, and version badges auto-inserted.

Quick start

Clone, install, and run commands formatted for copy-paste.

API overview

Endpoint tables with method, path, and description columns.

Contributing

Issue templates, PR checklist, and code of conduct link.

Example output

# project-name

![License](https://img.shields.io/...)

## Quick start

git clone ...

## API

| Method | Path | Description |

## Contributing

1. Fork the repo

Try this recipe Browse more recipes →