README Env-Vars Section Generator

A README without an environment-variables section leaves contributors guessing what to set. The README Env-Vars Section Generator produces the section in one click: a ## Environment Variables heading, a setup sentence, and a Markdown table of every variable with its Required flag, Default, and Description pulled from your file comments.

Paste your .env, choose whether to include the setup paragraph and whether defaults should be redacted, and copy the section straight into your README. No typing a table by hand, and no leaking production defaults to the public repo.

• Complete section: heading + paragraph + table.
• Description column: sourced from # comments.
• Required detection: empty values flagged.
• Markdown table: consistent alignment.
• Redact toggle: hide real defaults.
• Setup paragraph: optional copy instructions.
• Copy or download: paste-ready output.
• Private: fully client-side.

1. Paste your .env into the input, or load the sample.
2. Toggle the setup paragraph and redaction.
3. Click Generate. The section appears.
4. Copy it under “Environment Variables” in your README.

Example 1 — Public OSS. A library ships a redacted table so users see which variables exist without hinting at internal values.

Example 2 — Internal service README. A microservice README documents every variable so a teammate cloning the repo can start in minutes.

Example 3 — Template repository. A scaffold repo includes a generated section so newly bootstrapped projects already explain their config.

Example 4 — Documentation refresh. After adding a FEATURE_ flag, regeneration keeps the README in sync instead of editing by hand.

Example 5 — Hackathon demo. A demo repo gets a tidy configuration section that reviewers actually read.

• One click: a full section, ready to paste.
• Descriptions: reused from your comments.
• Safety: redaction for public repos.
• Consistent: the same clean table every time.
• Private: nothing uploaded.
• Free: use it on every project README.