DEV Community

Discussion on: How to write a kickass README

Collapse
 
tterb profile image
Brett Stevenson

This is a great (and necessary) introduction to writing helpful READMEs.
The only thing I would add is that I've found GIFs to be even more helpful than screenshots for showing off the functionality of your project.

Collapse
 
scottydocs profile image
James.Scott

I have used GIFs in the past (and yes, can be a great way to highlight functionality). You just need to mindful that you’ll need to update them if anything visual changes in your project (like with screenshots).