5-step workflowreadme github docs open-source documentation guided-flow Launch

GitHub README Generator

Write a README that makes people use your project: hook, quickstart, visuals, and honest docs.

Run this as a guided flow on Flows — verify gates and recovery prompts included →

Flows@flows12d ago

0 runs0 forks0

Chain

Inputs

Step 1

flow-github-readme-generator-1-write-the-hook-section

Step 2

flow-github-readme-generator-2-write-the-quickstart

Step 3

flow-github-readme-generator-3-write-usage-and-examples

Step 4

flow-github-readme-generator-4-add-project-meta

Step 5

flow-github-readme-generator-5-test-the-readme-cold

Final output

Workflow inputs

No inputs required — hit Run to stream each step in order.

Each step streams from its model and feeds the next. BYOK — you pay your provider directly. Add a key in Settings if a step needs one.

Step 1 · The first screen decides if anyone keeps reading.

flow-github-readme-generator-1-write-the-hook-section

Claude Sonnet 4.6→ {{step_1}}

Awaiting upstream steps…

Step 2 · From zero to running in minimal, tested steps.

flow-github-readme-generator-2-write-the-quickstart

Claude Sonnet 4.6→ {{step_2}}

Awaiting upstream steps…

Step 3 · Show the main use cases with real, current code.

flow-github-readme-generator-3-write-usage-and-examples

Claude Sonnet 4.6→ {{step_3}}

Awaiting upstream steps…

Step 4 · Status, license, and contribution basics complete the trust picture.

flow-github-readme-generator-4-add-project-meta

Claude Sonnet 4.6→ {{step_4}}

Awaiting upstream steps…

Step 5 · Follow it literally on a clean setup - fix every stumble.

flow-github-readme-generator-5-test-the-readme-cold

Claude Sonnet 4.6→ {{step_5}}

Awaiting upstream steps…

About this workflow

Write a README that makes people use your project: hook, quickstart, visuals, and honest docs.

What happens when you run it

1
The first screen decides if anyone keeps reading.
Runs flow-github-readme-generator-1-write-the-hook-section on Claude Sonnet 4.6
2
From zero to running in minimal, tested steps.
Runs flow-github-readme-generator-2-write-the-quickstart on Claude Sonnet 4.6
3
Show the main use cases with real, current code.
Runs flow-github-readme-generator-3-write-usage-and-examples on Claude Sonnet 4.6
4
Status, license, and contribution basics complete the trust picture.
Runs flow-github-readme-generator-4-add-project-meta on Claude Sonnet 4.6
5
Follow it literally on a clean setup - fix every stumble.
Runs flow-github-readme-generator-5-test-the-readme-cold on Claude Sonnet 4.6

Best for

•Recurring tasks you currently copy-paste between tools.
•When a single prompt isn't enough — you need a chain where output(n) feeds prompt(n+1).
•Fork and adapt if your inputs differ materially from the author's use case.

Models used

Claude Sonnet 4.6