Home › Developer Tools › README Generator
README Generator
Fill in a few fields and get a well-structured README.md for GitHub, GitLab or npm: badges, table of contents, installation, usage, configuration, roadmap, contributing, license and contributors. Watch the rendered preview as you type, then copy or download it.
Last updated:
Project basics
Badges
About & features
Installation & usage
Roadmap & contributing
License, contributors & contact
Advertisement
Advertisement
How to use the README Generator
- Enter your project basics: name, one-line tagline and, optionally, the GitHub repository (user/repo) and package name. These power the badges and install commands.
- Pick badges such as license, build status or npm version and choose a badge style.
- Describe the project: what it does, key features, and add a screenshot or demo link.
- Fill in installation and usage: choose a package manager to prefill commands and paste a short code example.
- Add the rest: configuration options, roadmap, license and contributors. Empty sections are left out automatically.
- Check the preview, then copy the Markdown or download README.md into the root of your repository.
Recommended README structure
| Section | What to write | Needed? |
|---|---|---|
| Title and description | The project name and one sentence on what it does and for whom | Always |
| Badges | Build status, version, license: quick signals of health and maturity | Recommended |
| About / screenshot | The problem it solves, a screenshot or GIF, a demo link | Recommended |
| Getting started | Prerequisites and the exact install commands | Always for code |
| Usage | The smallest example that works when copied and pasted | Always for code |
| Configuration | Environment variables or options, with defaults | If configurable |
| Roadmap | What is done and what is planned (GitHub renders task-list checkboxes) | Optional |
| Contributing | How to propose changes; link to CONTRIBUTING.md for long guides | For open source |
| License | The license name and a link to the LICENSE file | Always for open source |
| Contributors, acknowledgements, contact | Credits and how to reach the maintainers | Optional |
GitHub Markdown quick reference
| Element | Markdown |
|---|---|
| Heading | ## Installation |
| Bold / italic | **bold**, *italic* |
| Inline code | `npm test` |
| Code block with highlighting | ```js … ``` |
| Link / image | [text](https://…),  |
| Badge with link | [](https://…) |
| Task list | - [x] done, - [ ] to do |
| Table | | A | B | then | --- | --- | |
| Centered block | <p align="center">…</p> (HTML is allowed) |
| Note callout | > [!NOTE] on the first line of a blockquote |
Tips for a README people actually read
- Lead with the value. The first two lines should tell a visitor what the project does and why they would use it.
- Make the first example copy-paste ready. Test the install and usage commands in a clean environment.
- Show, don't tell. A screenshot or short GIF explains a UI faster than paragraphs.
- Use relative paths for images and files inside the repository (
docs/screenshot.png) so they work on forks and branches. - Keep it current. Update the README in the same pull request that changes installation or usage.
Frequently asked questions
What should a good README include?
At minimum: the project name, a one-sentence description, how to install it, a short usage example and the license. Larger projects add badges, screenshots, configuration options, a roadmap, contributing guidelines and credits.
Where do I put README.md?
In the root folder of your repository. GitHub, GitLab and Bitbucket show it automatically on the project's main page, and npm displays the README of a published package.
How do the badges work?
Badges are images served by shields.io. Dynamic badges such as stars, license or build status read live data from GitHub, npm or PyPI each time the README is viewed, so they need the correct user/repo or package name. They only appear once the repository or package is public.
Why do table of contents links work on GitHub?
GitHub creates an anchor for every heading by lowercasing it, removing punctuation and replacing spaces with hyphens. The generator builds the table of contents with the same rule, so #getting-started jumps to the Getting Started heading.
Does the README include the full license text?
No. The README names the license and points to a LICENSE file, which is the convention. Create that file separately, for example with a license generator.
Is my project information uploaded?
No. The README is generated in your browser and the draft is only saved in local storage. Badge images in the preview load from shields.io like they would on GitHub.
Are all the tools on FreeToolCabin tested for quality and accuracy?
Yes! Every tool on our site undergoes automated Q/A testing in real browser environments to ensure high precision, correct output, and zero errors. If you happen to spot a bug or have a suggestion, please contact us at [email protected] and our team will review it right away.
Related tools
Markdown EditorWrite Markdown with a toolbar, live split preview, autosave and .md or HTML export.License GeneratorCreate a LICENSE file for MIT, Apache, GPL, BSD, ISC, MPL or Unlicense with your name and year.Gitignore GeneratorBuild a .gitignore from 50+ templates for languages, frameworks, IDEs and OS, merged and deduped.Markdown Table GeneratorBuild Markdown tables in a grid or paste from Excel/CSV, with alignment and preview.Code of Conduct GeneratorCreate a code of conduct for a community, open source project or event, with reporting and enforcement.QR Code GeneratorMake QR codes for links, Wi-Fi, email and more.Barcode GeneratorCreate Code 128, EAN-13, UPC-A, EAN-8, Code 39 and ITF-14 barcodes as PNG or SVG.UUID GeneratorGenerate UUID v4 and v7 / GUIDs in bulk and copy or download them.Schema Markup Generator (JSON-LD)Create JSON-LD structured data for FAQ, Product, Article and more.Htaccess & Nginx Redirect GeneratorBuild 301 redirects for .htaccess, Nginx and Netlify or Cloudflare _redirects.Fake Data GeneratorGenerate mock data as JSON, CSV or SQL.Random String GeneratorGenerate secure random strings and tokens in bulk with any length and character set.API Key GeneratorCreate secure API keys and secrets with prefixes, checksums and SHA-256 hashes for storage.MIME Type LookupFind the MIME type for any file extension, or the extensions for a MIME type, in 400+ entries.Cron Expression GeneratorBuild crontab schedules visually, read them in plain English and see the next run times.URL Slug GeneratorTurn titles into clean, SEO-friendly URL slugs: accents, stop words, separators and bulk lines.JSON Schema GeneratorTurn sample JSON into a draft 2020-12 JSON Schema with types, required fields and formats.ULID GeneratorGenerate sortable ULIDs and UUID v7 in bulk, monotonic option, and decode their timestamps.Htpasswd GeneratorCreate .htpasswd entries with bcrypt, APR1-MD5 or SHA-1 for Apache and Nginx basic auth.Placeholder Image GeneratorCreate placeholder images in any size, color and text as PNG, JPG, WebP, SVG or data URI.Ads.txt GeneratorCreate or validate ads.txt and app-ads.txt files: seller lines, cert IDs and variables.Docker Run to Compose ConverterConvert docker run commands to docker-compose.yml, or a compose file back to docker run.Dockerfile GeneratorGenerate a production Dockerfile and .dockerignore for Node, Python, Go or a static nginx site.HTML Boilerplate GeneratorTick the options you need and get a clean HTML5 starter template with meta, OG tags and CSS reset.JSON to Zod SchemaInfer a Zod (or Yup) schema from sample JSON with optional, nullable and z.infer types.Linux Commands Cheat SheetSearchable Linux and bash command reference with flags explained, examples and copy buttons.LLMs.txt GeneratorBuild an llms.txt file for AI crawlers: summary and link sections, import from your sitemap.Nano ID GeneratorGenerate secure Nano IDs with custom alphabet, length and count, plus a collision calculator.Nginx Config GeneratorBuild an nginx server block: static site, SPA, reverse proxy or PHP, with SSL, gzip and redirects.OpenAPI / Swagger ViewerView OpenAPI 2/3 JSON or YAML as interactive API docs with validation and an endpoint list.package.json GeneratorFill a form and get a valid, npm-ready package.json with scripts, dependencies and checks.PKCE Code Challenge GeneratorGenerate an OAuth 2.0 PKCE code_verifier and S256 code_challenge, build auth URLs, verify pairs.Regex GeneratorBuild regular expressions visually from blocks or presets (email, date, phone) and test them live.Commit Message GeneratorBuild Conventional Commit messages with type, scope, body, breaking change and issue refs.Database Schema DesignerDesign tables and relationships visually, then export SQL for MySQL, PostgreSQL or SQLite.Docker Compose GeneratorBuild a docker-compose.yml with a form: services, ports, volumes, env, healthchecks and presets.Dummy File GeneratorCreate test files of an exact size in KB, MB or GB with zeros, random bytes or text.FFmpeg Command GeneratorPick a task and options, get the exact ffmpeg command with every flag explained.PIN GeneratorGenerate random 4, 6 or 8-digit PINs that avoid sequences, repeats, dates and common PINs.Product Schema GeneratorBuild Product JSON-LD with price, availability, brand, GTIN, ratings and reviews.Question Keyword GeneratorFind the questions people ask about a topic, grouped by who, what, why, how, can and more.Recipe Schema GeneratorCreate Recipe JSON-LD with ingredients, steps, prep and cook times, nutrition and ratings.Security Headers GeneratorPick HSTS, CSP, frame, referrer and permissions options and get Apache, Nginx, Netlify or Cloudflare config.SKU GeneratorBuild consistent SKUs from brand, category, size and color, then export every variant as CSV.Typography Scale GeneratorBuild a modular type scale from a base size and ratio, then copy CSS variables or a Tailwind config.WordPress Salt GeneratorGenerate fresh WordPress security keys and salts for wp-config.php, .env or Docker in one click.ANSI Color Code GeneratorStyle terminal text with 16, 256 or RGB colors and get escape codes for bash, Python, JS and C.Apache Virtual Host GeneratorCreate an Apache VirtualHost config with SSL, redirects, reverse proxy or PHP-FPM in seconds.Bash Prompt GeneratorDrag and drop a custom PS1 prompt for bash or zsh with colors, git branch and a live preview.Changelog GeneratorTurn Conventional Commit messages into a grouped Keep a Changelog Markdown file per version.cURL Command BuilderBuild curl commands from a form: method, headers, query, JSON or form body, auth and flags.Docker Compose to KubernetesConvert docker-compose.yml into Kubernetes Deployment, Service, ConfigMap and PVC manifests.Docker Compose ValidatorCheck a docker-compose.yml for YAML errors, schema mistakes, broken references and deprecated keys.Dockerfile LinterLint a Dockerfile for best practices: pinned tags, apt cleanup, non-root USER and layer count.Dockerignore GeneratorBuild a .dockerignore from Node, Python, Go and Java templates, plus your own entries.ESLint Config GeneratorGenerate a flat eslint.config.js for JavaScript, TypeScript, React or Node with rule presets.Git Branch Name GeneratorTurn a ticket ID and title into a clean, valid git branch name like feature/PROJ-12-add-login.GitLab CI Config GeneratorGenerate a .gitlab-ci.yml with stages, jobs, images, cache, artifacts and rules from templates.Jinja2 Template TesterRender Jinja2 templates with YAML or JSON variables using real Jinja2, with clear error lines.JSON Schema Mock Data GeneratorGenerate realistic sample JSON from a JSON Schema: formats, patterns, $ref, seeds and counts.Kubernetes Secret GeneratorCreate Kubernetes Secret YAML from key/value pairs or .env with auto base64, or decode one.Kubernetes YAML ValidatorValidate Kubernetes manifests against the API schema of a chosen version, with error paths.Prettier Config GeneratorToggle Prettier options, preview formatted code live and copy your .prettierrc file.Quartz Cron GeneratorBuild and explain Quartz and Spring cron expressions with seconds, ?, L, W and #, plus next fire times.README Badge GeneratorCreate Shields.io-style README badges for license, version, build and custom labels.Systemd Service File GeneratorCreate a systemd .service unit with ExecStart, user, restart policy, environment and hardening.tsconfig.json GeneratorBuild a tsconfig.json with target, module, strict checks and path aliases, each option explained.Access Log AnalyzerAnalyze Apache and Nginx access logs: top URLs, IPs, status codes, bots and traffic charts.