Back to Docs
Recipe

SDK quickstart README writer

Generate a polished, copy-paste ready README for any SDK in under 60 seconds. Meridian pulls your package name, install command, and API surface into a structured template.

What it does

Paste your package name and a short description. Meridian scaffolds a complete README with install instructions, usage examples, API reference table, and contribution guidelines — all formatted in clean Markdown.

Quick run

meridian recipe sdk-readme \
  --package @acme/client \
  --desc "Type-safe HTTP client for Node.js" \
  --output README.md

That is it. Open README.md and push.

Template sections

  • Installation
  • Quick start
  • API reference
  • Configuration
  • Error handling
  • Contributing

Next steps

Pair this with Recipe: Changelog generator to keep your release notes in sync. For advanced customization, see the full recipe reference.

Ready to ship? Open Dashboard →