DEV Community

Discussion on: How to write a good README? #discuss

Collapse
 
sleepyfran profile image
Fran González

I always thought of README as a quick look over a project: what is it about and how to set it up quickly with some examples and a link to the documentation in case I need it. In this area, after a quick look on yours, I think it does it perfectly.