README Generator

Your workspaceProcessed on your device
Project details
Plain text. Leave an empty line between paragraphs.
Features and screenshot
Use one per line. Start a task with [x] for done or [ ] for open.
Use one per line.
Setup and usage
Project files and maintainers

Undo: Ctrl/Cmd+Z · Redo: Ctrl/Cmd+Shift+Z or Ctrl+Y. Up to 20 steps and 4 million retained characters in this tab. Clear discards history.

A few things to know.

Project name and description are required. Add up to 30 features, 12 technology names and one screenshot. Description and commands accept up to 4,000 characters per field. The preview shows links as text and images as labels. Saved Markdown can contain external URLs.

  1. Enter a project name and description, or load the Trail Ledger example.
  2. Add the sections readers need. Leave other fields blank and choose whether to include a table of contents or badges.
  3. Generate README.md, review the preview and Markdown, then copy or download the file.