DevToolsHub Free · Fast · 100% in your browser

README Generator

Create a professional GitHub README.md with badges, sections and a live preview.

Awesome Project

License

A short, catchy description of what this project does and who it is for.

Table of contents

Features

  • Fast and lightweight
  • Works offline
  • Zero configuration

Tech stack

  • TypeScript
  • Node.js

Installation

npm install awesome-project

Usage

npx awesome-project --help

Contributing

Contributions are welcome!

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push the branch (git push origin feature/amazing-feature)
  5. Open a pull request

License

Distributed under the MIT License. See LICENSE for more information.

About this README generator

A good README is the first thing people see on GitHub. Fill in your project's name, description, features, installation and usage, pick a license and the generator builds a well-structured README.md with shields.io badges, a table of contents and contributing guidelines, with a live preview.

How to use the README Generator

  1. Fill in your project details.
  2. Choose badges and sections.
  3. Copy or download README.md and commit it to your repository.

Frequently asked questions

Where do the badges come from?

Badges are served by shields.io. Enter owner/repo to add stars, issues and last commit badges for your GitHub repository.

Can I edit the result?

Yes. Copy the Markdown and adjust it in your editor; it is plain GitHub Flavored Markdown.

Is my data safe?

Yes. The tool runs entirely in your browser using WebAssembly. Nothing you type or upload is sent to a server, logged or stored.

Is it free?

Yes, completely free with no sign-up, no limits and no watermarks. It also works offline once the page has loaded.

An unhandled error has occurred. Reload ✕