DEV Community

Cover image for Announcing GitHub README Templates - Amazing README's to get you started with your own.
Twan Mulder
Twan Mulder

Posted on

Announcing GitHub README Templates - Amazing README's to get you started with your own.

Hello and thank you checking out my post about GitHub README Templates!

Adding an amazing README to your GitHub project is a great way of introducing new people to the codebase, teaching them about how to use your project/code, and will inspire them to contribute themselves.

I've always struggled with what makes a great README. That's why I've gathered some that I really enjoyed and made them available on www.readme-templates.com.

You can preview all the README's, copy their markdown, and view the original projects on GitHub.

I'd love to hear what you think and if you have any README's you can recommend to add!

Cheers 😄

www.readme-templates.com

Top comments (14)

Collapse
 
qq449245884 profile image
qq449245884

Dear Iain Twan Mulder,may I translate your this article(medium.com/dailyjs/13-javascript-o...) into Chinese?I would like to share it with more developers in China. I will give the original author and original source.

Collapse
 
vinitshahdeo profile image
Vinit Shahdeo

Glad to see a curated list of awesome READMEs.

Great work! README acts as a door to your open-source project. Having said that I always spent a lot of time to craft my READMEs: github.com/vinitshahdeo

Sharing a few from mine tiny space on GitHub:

Collapse
 
toktoktwan profile image
Twan Mulder

Really cool! Thanks for providing these 😄 I'll check them out later today, I'll let you know when I added one (or more 😉) of them!

Collapse
 
madza profile image
Madza • Edited

hoppscotch has a great one 😉
@liyasthomas

Collapse
 
itsabdessalam profile image
Abdessalam Benharira

It's really a great idea to have them all there. All I have to do is choose the one that fits my project. Well done! 🙌

Collapse
 
toktoktwan profile image
Twan Mulder

Thanks for checking it out! Hope it can help you out sometime 😄

Collapse
 
andrewbaisden profile image
Andrew Baisden

Nice going to use this for inspiration.

Collapse
 
devanquinn profile image
Devan Quinn

How did u allow the markdown to appear on the right side when clicking the button? Beautiful site btw

Collapse
 
toktoktwan profile image
Twan Mulder

Thank you! I used the "react-markdown" npm package to render the markdown as actual HTML github.com/remarkjs/react-markdown

Collapse
 
taransuresh profile image
Taran Suresh

This is awesome, I’ve been looking for a good way to document my projects the best way. Cheers.

Collapse
 
toktoktwan profile image
Twan Mulder

Thank you! Hope it can help you out

Collapse
 
vikash2806 profile image
vikash2806

Great article! Thanks for sharing 👏

Do checkout this profile: github.com/VikashPR

Image description

Collapse
 
crazilazi profile image
Rajeev Ranjan

This is really cool, thank you for your hardwork.

Collapse
 
toktoktwan profile image
Twan Mulder

Thanks you!