How it works

Describe your project in a few lines, or paste the main file, package.json or CLI entry point. Include commands, flags and environment variables.
Pick the project type (library, CLI, web app, internal tool or portfolio), add the license or runtime version, and click Write my README.
Copy the Markdown into README.md, replace any [placeholders], and run every command in it once on a clean machine.

Examples

Sample results for the inputs shown, so you can see the format and quality before you try it.

Example 1: input

Describe the project or paste the main code: Node CLI that finds past-due Stripe invoices and emails reminders at 3, 7 and 14 days overdue. Exclude list of customer IDs. --dry-run flag to preview. Script: npm run remind. Env: STRIPE_SECRET_KEY, SMTP_URL, FROM_EMAIL, EXCLUDE_CUSTOMERS. Node 20+.

Project type: Command-line tool

Example 1: output

# invoice-reminder Sends polite reminder emails for unpaid invoices in your Stripe account, on a schedule you choose. ## Features - Finds Stripe invoices that are past due - Sends reminder emails at 3, 7 and 14 days overdue - Skips customers you add to an exclude list - Dry-run mode to preview emails without sending ## Requirements - Node.js 20 or later - A Stripe secret key - An SMTP account for sending email ## Installation ``` git clone [repository URL] cd invoice-reminder npm install ``` ## Configuration Copy `.env.example` to `.env` and set: | Variable | Description | |---|---| | STRIPE_SECRET_KEY | Your Stripe secret key | | SMTP_URL | SMTP connection string | | FROM_EMAIL | The address reminders come from | | EXCLUDE_CUSTOMERS | Comma-separated Stripe customer IDs to skip | ## Usage Preview what would be sent: ``` npm run remind -- --dry-run ``` Send reminders: ``` npm run remind ``` Run it daily with cron or your scheduler of choice. ## Contributing [How you'd like people to contribute: issues, pull requests, code style] ## License [License]

Example 2: input

Describe the project or paste the main code: Python CLI fastcsv-clean on PyPI. Trims whitespace, normalizes dates with --dates FORMAT, removes duplicate rows with --dedupe, --report prints changes. Usage: fastcsv-clean input.csv -o output.csv

Project type: Open-source library or package

Anything else to include: MIT license, Python 3.10+

Example 2: output

# fastcsv-clean A command-line tool that cleans messy CSV files: trims whitespace, fixes inconsistent date formats and removes duplicate rows. ## Install ``` pip install fastcsv-clean ``` Requires Python 3.10 or later. ## Usage ``` fastcsv-clean input.csv -o clean.csv ``` Options: - `--dates YYYY-MM-DD` converts every date column to the format you give - `--dedupe` removes exact duplicate rows - `--report` prints what changed Example: ``` fastcsv-clean sales.csv -o sales_clean.csv --dates YYYY-MM-DD --dedupe --report ``` ## License MIT

Example 3: input

Describe the project or paste the main code: Next.js internal dashboard for the ops team: daily order volume, fulfillment time, late shipments. Reads from orders Postgres with read-only creds from .env. Refreshes every 15 min. npm run dev on port 3000. Deployed on Railway from main.

Project type: Internal tool (for my team)

Example 3: output

# ops-dashboard Internal dashboard that shows daily order volume, fulfillment times and late shipments for the warehouse team. ## What it's for The ops team checks this each morning to spot late shipments before customers do. It reads from the orders database (read-only) and refreshes every 15 minutes. ## Running locally 1. Get the read-only database credentials from [where the team stores secrets]. 2. Copy `.env.example` to `.env` and add the credentials. 3. Install and start: ``` npm install npm run dev ``` 4. Open http://localhost:3000. ## Deployment Deployed on Railway from the `main` branch. [confirm: whether deploys are automatic on merge] ## Ownership Maintained by [team or person]. Report problems in [channel].

Tips for better results

Paste the real commands and environment variables. The README uses them exactly, and a command that doesn't run is worse than none.
Say who it's for. A README for your team needs "who owns this"; one for open-source users needs install and a code example first.
Test the install steps from a fresh clone. It's the fastest way to find the step you forgot because it's already set up on your machine.
Update the README in the same pull request as the feature. A README that describes last year's flags sends people in circles.

FAQ

Is this README generator free?

Yes. Enter your email once to use it (you'll also get Something Big, our free weekly AI newsletter, and you can unsubscribe anytime). There's no account and no credit card.

What should a README include?

What the project does and for whom, requirements, installation, configuration, usage with examples, and a license. Open-source projects add a contributing section; internal tools add who maintains them.

Does it write GitHub-flavored Markdown?

Yes. The output is Markdown with headings, fenced code blocks and a configuration table, ready to save as README.md for GitHub, GitLab or Bitbucket.

Will it add features or badges I don't have?

No. It documents only what you describe or what the code shows, and uses [placeholders] for anything missing, such as the repository URL or license.

More free AI tools

Related prompts

Prefer to use ChatGPT or Claude directly? These free prompts do similar jobs.