Cooking the perfect README every single time
ReadmeChef is a web application that helps developers and organizations create beautiful, comprehensive README files for their GitHub repositories in minutes.
- Save Time: Stop wasting hours manually writing READMEs. ReadmeChef automates the process, allowing you to focus on coding.
- Professional Quality: Create polished, professional-looking READMEs that impress potential users and contributors.
- Easy to Use: Our intuitive interface makes it simple to create and customize your README, even if you're not a Markdown expert.
- Stay Consistent: Ensure all your projects have consistent, high-quality documentation.
- Attract Contributors: A well-written README makes your project more accessible and inviting to potential contributors.
- One-Click Generation: Connect your GitHub account and generate professional, comprehensive READMEs with a single click - no more spending hours on documentation.
- Smart Repository Analysis: Our AI scans your GitHub repository, analyzes code structure, dependencies, and purpose to craft a perfectly tailored README that accurately represents your project.
- Public & Private Access: Choose between basic access for public repositories or extended access for both public and private repos, giving you full control over your GitHub integration.
- Node.js v20 or higher
- npm or yarn
-
Clone the repository
git clone https://github.com/samitkapoor/readmechef.git cd readmechef -
Install dependencies
npm install # or yarn install -
Start the development server
npm run dev # or yarn dev -
Open http://localhost:3000 in your browser to see the application
We welcome contributions to ReadmeChef! Here's how you can contribute:
- Create an issue describing the bug or feature request.
- Get assigned to the issue.
- Fork the repository.
- Create a branch for your changes.
- Submit a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.