๐Ÿš€I Built Dokugen โ€“ A Tool That Automates README Docs!

i-built-dokugen-โ€“-a-tool-that-automates-readme-docs!

Hey devs! ๐Ÿ‘‹ I recently built Dokugen โ€“ an AI-powered tool that generates README.md files automatically based on your GitHub repository.

I created this because I noticed many devs either:

Spend too much time writing detailed READMEs

End up with incomplete or missing project documentation

So I thought: Why not automate it?

What is Dokugen?

Dokugen is an open-source CLI tool that scans your GitHub repo and instantly generates a well-structured, professional README for you. It analyzes your code and produces:
โœ… A clear project description
โœ… Installation & setup steps
โœ… Usage examples
โœ… Features & technologies used
โœ… Contributing guidelines

All in just one command!

How It Works

1๏ธโƒฃ Install Dokugen:

npm install -g dokugen

2๏ธโƒฃ Run it in your project folder:

npx dokugen generate

3๏ธโƒฃ Boom! Your README.md is generated.

Why I Built This

I’ve seen many cool open-source projects without a proper README โ€“ which makes them hard to understand and use. I wanted to fix that.

With Dokugen, you can:
๐Ÿš€ Save time writing documentation
๐Ÿ”ฅ Make your projects look professional instantly
๐Ÿค Attract more contributors to your repo

๐Ÿš€ Try It Out!

Dokugen is free and open-source! You can check it out here:
๐Ÿ”— GitHub:
Image descriptiongithub.com/samueltuoyo15/Dokugen

Would love to hear your thoughts! What do you think? Any features you’d like me to add? Letโ€™s discuss in the comments! ๐Ÿ˜Š

Total
0
Shares
Leave a Reply

Your email address will not be published. Required fields are marked *

Previous Post
aws-redshift-cheat-sheet

AWS Redshift Cheat Sheet

Next Post
pil-and-mental-health:-generally-using-the-law-to-make-changes

PIL and Mental Health: Generally Using the Law to Make Changes

Related Posts