READMEaker

Readmeaker is an online editor to help developers make readmes for their project.

Check the video out on: YOUTUBE

If you are an avid reader check: READMEaker blog if you prefer slides: READMeaker Slide Deck Link to production site: READMEaker

Features

• Instant README generation with AI
• Customizable README templates
• Choose from list of sections to add to your readme
• Edit the contents of each section
• Copy or Download your readme file

Installation

No installation required. Access the app directly via the link to production site.

Usage

1. Go to the READMEaker.
2. Fill in your project details.
3. Generate and download your README file.

Contributing

Contributions are always welcome!

See CONTRIBUTE.md for ways to get started.

Tech Stack

• Next.js
• TailwindCSS
• react-markdown

Running the Dev Server

To run the dev server, run npm run dev and navigate to localhost:3000

Feedback

Feedback is appreciated! Reach out on Twitter or submit a new issue!

License

MIT

This readme was created with READMEaker