README Template Generator
Description
When a README template generator is the right tool
Use this page to draft a starter README.md with a title, optional tagline, demo link, table of contents, About, Installation, Usage, optional Contributing, and a License heading. The Markdown updates as you type. It does not read your repository.
Use cases
Starting from the defaults
Leave most fields blank to get the skeleton below: placeholder About text, npm install / npm start, a Contributing blurb, and a MIT link to LICENSE. Turn off Table of Contents or Contributing if you do not want those sections. License choices are MIT, Apache 2.0, GPL-3.0, BSD-2-Clause, BSD-3-Clause, ISC, MPL-2.0, and Unlicense.
Adding a repo and badges
Fill GitHub Repo as owner/repo-name if you want badge links and the longer Contributing steps. Badge chips start with License and Build status selected; they still will not appear until a repo is set.
How the file is built
Installation and Usage are always wrapped in bash code fences. A tagline is written as a block quote. A demo URL becomes a bold Live Demo link. The Preview tab does not run a Markdown renderer.
# My Project
## Table of Contents
- [About](#about)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## About
A short description of what your project does and why it exists.
## Installation
```bash
npm install
```
## Usage
```bash
npm start
```
## Contributing
Contributions are welcome! Please open an issue or submit a pull request.
## License
[MIT](LICENSE)What this tool does not do
It does not pull stars, tests, or package versions, render Markdown as HTML, or write a license body. For a LICENSE file, use License Text Generator. Generation stays in your browser.
How to use README Template Generator
- Fill the project name and any optional fields you want, including a repo if you need badges.
- Toggle badges, Contributing, Table of Contents, and a license name.
- Copy or Download
README.md, then edit the placeholder sections in your editor.
Frequently asked questions
How does README Template Generator work?
The Markdown on the right updates as you fill the form. An empty project name becomes “My Project.” Empty installation and usage fields become npm install and npm start inside bash fences. An empty About section uses a short placeholder sentence. Copy and Download (README.md) stay in your browser. This is a template builder, not a GitHub import.
When do badges appear, and are they live stats?
Badges are written only when a GitHub repo in owner/repo form (or a similar path) is filled. They are static shields.io badge images with a fixed label and color, not live npm version, star, build, or coverage counts. The npm badge links to npmjs.com using the segment after the slash (or the whole field if there is no slash). License, stars, build, and coverage badges link into that GitHub repo; “PRs welcome” links to makeapullrequest.com.
What does the Preview tab show? What else depends on the repo field?
Preview shows the same Markdown in a monospaced block — it is not rendered HTML. If a repo is set, the Contributing section adds a five-step fork/branch/commit/push/PR list, and the License line links to github.com/<repo>/blob/main/LICENSE with the current year from this device’s clock. Without a repo, License is [MIT](LICENSE) (or whichever name you picked). The license menu only writes a name and a link; it does not insert the license body.
Is my project uploaded?
No. The file is assembled in your browser. Nothing is fetched from GitHub or npm when you type a repo name. Opening the README later in GitHub will load any shields.io images from that host.
Related tools and guides
References
- Badge images use the static shields.io “badge” endpoint with a fixed label and color, not the live npm or GitHub statistic endpoints.
- For a full license file rather than a name and link, use the License Text Generator linked above, and note that its GPL and MPL entries are stubs.