DEV Community

Discussion on: What are some examples of open-source projects with great READMEs?

Collapse
 
milantenk profile image
Milán Tenk

I made recently one of my hobby projects open source. It is an Angular component, you can check its README here:
github.com/milantenk/ngx-interacti...

What I held important to have

  • a gif, which gives a rough overview about the component
  • a live demo link, which can give a hands-on experience
  • description about the usage of the component
  • a short summary, how to get started with the development of the library
Collapse
 
radiomorillo profile image
Stephanie Morillo

I love the GIF and link to live demo!!! That's an awesome concept. Thank you for sharing!