Loading…
Loading…
Generate a formatted README.md with badges, TOC, and live preview
# My Project [](https://github.com/username/repo/actions) [](https://opensource.org/licenses/MIT) ## Table of Contents - [Features](#features) - [Tech Stack](#tech-stack) - [Installation](#installation) - [Usage](#usage) - [Contributing](#contributing) - [License](#license) ## Features - Feature one - Feature two - Feature three ## Tech Stack - **Node.js** - **TypeScript** ## Installation Clone the repository: ```bash git clone https://github.com/username/repo cd my-project npm install ``` ## Usage ```bash npm start ``` ## Contributing Contributions are welcome. Please open an issue first to discuss what you would like to change. 1. Fork the repository 2. Create a feature branch (`git checkout -b feature/amazing-feature`) 3. Commit your changes (`git commit -m 'feat: add amazing feature'`) 4. Push to the branch (`git push origin feature/amazing-feature`) 5. Open a Pull Request ## License [MIT](LICENSE)
Run your projects on Claude Code?
We packaged the .claude config that runs this site — 26 specialist agents, 14 workflow skills, and 6 rule files from 31 real production incidents. From $9.
Get the Claude Code Production Pack — $29A good README is the first impression of every open-source project. This generator takes your project details and outputs a complete, properly structured Markdown file in seconds.
A template engine assembles Markdown by interpolating your inputs. Badge URLs are constructed from shields.io endpoints. TOC is generated from active sections.
A developer generates a complete README for a new open-source project in 3 minutes.
A team standardizes README files across all internal repositories.
Fill in project name, GitHub repo path, and description
Add tech stack and feature list
Select badges and choose a license
Download .md or copy to clipboard
About the README Generator
Yes. Badges use shields.io URLs with your GitHub repo path for live data.
Title, badges, description, TOC, features, tech stack, installation, usage, license. Optional: API Reference, Contributing.
Yes. Both Installation and Usage fields accept raw Markdown including fenced code blocks.
Write Markdown with instant live preview and HTML export
Open →DeveloperYour AI API bill on the day each price change lands, and the cheapest switch
Open →DeveloperFind what breaks when Chrome 158 turns XSLT off on 17 Nov 2026
Open →DeveloperHow many days your $100, $200 or $500 API credit lasts
Open →