README Generator
Pick a template, fill in the sections you need, and watch the README assemble live. Drop in shields.io badges, build a TOC, generate the license block — copy as Markdown or export as HTML.
Sections enabled
11
of 17
Words
198
Approximate word count of your README.
Characters
2009
Including Markdown syntax.
Templates
Start from a sensible baseline. You can still toggle individual sections after picking one.
Sections
Toggle, reorder, and configure each block. Changes save to this browser.
Live preview
Switch tabs to copy raw Markdown or inspect the rendered HTML.
🚀 My Awesome Project
> A thoughtfully designed tool that solves a real problem.
!License !Version !Stars !PRs Welcome
Briefly explain what your project does, why it exists, and who it is for.
Keep this part scannable — two short paragraphs land better than one long wall.
Table of Contents
- Features
- Installation
- Usage
- Tech Stack
- Contributing
- Contact
- License
- Fast, focused, and dependency-light
- Sensible defaults you can override
- Typed end-to-end
Features
Installation
bashnpm install your-package
Usage
tsimport { doThing } from "my-awesome-project";
doThing({ option: true });
A one-line description of what the snippet above accomplishes.
Tech Stack
Contributing
Contributions, issues, and feature requests are welcome. Feel free to check the issues page.
See the contribution guide for details on how to get started.
Contact
Your Name
License
MIT License
Copyright (c) 2026 Your Name
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction. See the LICENSE file for full text.