README Generator (README.md for GitHub)

A good README is the front page of a project: it says what the project does, how to install and use it, and how to contribute, and it is the first thing people see on GitHub, npm and GitLab. This generator turns a short form into a complete README.md with the sections readers expect — badges, description, features, installation, usage, tech stack, API, contributing, licence and author — and can also give you the rendered HTML.

How to use this tool

1. Enter the project name, a one-line description and the GitHub repository (owner/name).
2. Fill in the features, installation commands and a usage example; leave anything empty to skip that section.
3. Choose the licence and the extras: badges, screenshots placeholder, contributing guide, table of contents.
4. Copy the Markdown into README.md at the root of your repository.

Formula

# Name → badges → description → About → Features → Built with → Installation → Usage → API → Contributing → License → Author

Sections with no content are left out. Code goes in fenced blocks whose fence is longer than any run of backticks inside the code, so nothing breaks. Badges use shields.io: a static licence badge (with "-" written "--" as shields.io requires), npm version and downloads, and GitHub stars, issues and last commit. Table-of-contents links follow GitHub's heading anchors (lower case, spaces as hyphens, punctuation removed). The HTML version is produced with the marked library in GitHub-flavoured mode.

Example

The sample creates a README for awesome-cli with a licence badge and three GitHub badges, the tagline, an About paragraph, three features, Node.js and TypeScript under "Built with", a clone command followed by npm install -g awesome-cli, a usage block, the contributing steps, an MIT licence line and the author — 8 sections in all.