Generate beautiful README in 10 seconds

Hi 👋

A well structured and beautiful README is very important, especially for opensource projects. This is the first thing that visitors will see when they discover your project.

This is why I created readme-md-generator, a tool that generates beautiful basic README.md files with less efforts !

All you need to do is answer a few questions, and readme-md-generator will do the rest 👌

readme-md-generator is able to read your environment (package.json, git config...) to suggest you default answers during the README.md creation process :

Generated README.md :

Feel free to check out the github repos if you're interested !

Comments

[Arturs Smirnovs]

Nice, good job creating generator.. i made one my self for fun: arturssmirnovs.github.io/github-pr...

[Gilton]

Great post!! Thanks a lot!!

[Al Romano]

This is awesome!!!! :D

[JaredHarbison]

I like it. I love it. Consistency and convention! For a future iteration... maybe a linkedin prompt along with github and twitter?

[Franck Abgrall]

Incoming!! github.com/kefranabg/readme-md-gen...

[Douglas "Amarelo" Lopes]

Hey, cool!

It is usually difficult and annoying to create a readme file. There is no standard way of doing this, everyone has to create their own and it is not always simple and easy to understand.
With this tool, we have a well-planned and structured way of doing this.

Well done. This is a very good tool.

Thanks for sharing.

[Mahesh K]

Thank you. I tested it. Really handy tool. :)

[Steffen Pedersen]

This is pretty cool ✌🏻 It's great if you don't know how to start writing a README file.

[Sumit Roy]

How they generated their README.md file?

[Varun]

Franck ,this is so Good.I always find difficulties remembering markdown syntax and creating readme files.
Using this project , I will never be lazy again in creating consistent ,useful and beautiful readme files.

Thanks a lot.

[K-Sato]

Neat

[Thiago Luiz Silva]

Wow!!! Great!

[José Coelho]

Wow! Great idea! This is what I need at work, most of my colleagues have never written a Readme file. 😒

[Peter Jausovec]

this looks great! now I have to go back to every github repo I have, and re-generate readmes :)

[Tony Greeley]

This is amazing! Great work! Thank you!