README.md Generator
Fill in your project details and get a tidy README.md in the conventional order: title, tagline, badges, description, table of contents, features, installation, usage, API, contributing and license. Sections you leave blank are skipped, so there are no empty headings. Copy it or download README.md.
How to generate a README.md
- Enter your project name, then add features, installation and usage details.
- Toggle a table of contents, contributing section and pick a license.
- Copy the Markdown or download it as README.md into your repository.
Examples
Minimal library README
projectName: "My App", features: ["Fast","Simple"], installation: "npm install my-app", license: "MIT"
# My App ## Features - Fast - Simple ## Installation ```bash npm install my-app ``` ## License MIT
Frequently asked questions
What is a README.md file?
README.md is the Markdown file shown on a repository's home page on GitHub, GitLab and similar hosts. It introduces the project and usually covers what it does, how to install it, how to use it and the license.
What sections does the generator include?
Title, an italic tagline, a badges line, a description, an optional table of contents, then Features, Installation, Usage, API, Contributing and License. It only outputs the sections you fill in, so you never get empty headings.
Do I need to know Markdown to use it?
No. You fill in plain fields and the tool produces the Markdown for you. If you do know Markdown you can write it directly in the description, usage and API fields and it is passed through as is.
How does the table of contents work?
When you have two or more sections the tool adds a Table of Contents with links that jump to each heading. The anchors follow the GitHub convention, so they work once the file is rendered in your repository.
Where do I put the generated file?
Save it as a file named exactly README.md in the root of your repository. Hosts like GitHub render the root README on the project page automatically. You can also keep extra README files inside subfolders.
Is my project information sent to a server?
No. The README is assembled entirely in your browser from the fields you enter, so nothing you type leaves your machine.
Related tools
Markdown to HTML
Convert Markdown to clean HTML in your browser. Headings, bold, italic, links, images, lists, blockquotes and fenced code blocks, with text safely escaped.
Gitignore Generator
Build a .gitignore from Node, Python, Java, Go, Rust, macOS, Windows and more. Pick your stacks, copy or download the file. Runs in your browser.
GitHub Actions Generator
Build a ready-to-use GitHub Actions CI workflow. Pick triggers, language, version matrix and steps, then copy or download the .github/workflows YAML.
.env to JSON
Convert a .env file to JSON, or JSON back to .env. Parses KEY=value lines, comments, quotes and export. Runs entirely in your browser.
Aspect Ratio Calculator
Calculate aspect ratios fast. Enter a ratio like 16:9 and one dimension to get the other, or enter width and height to simplify the ratio.
Base58 Encoder
Encode and decode Base58 online with the Bitcoin alphabet. Convert text to Base58 or back, UTF-8 safe, no confusing 0 O I l. Runs in your browser.