DEV Community

Discussion on: How to write a kickass README

Collapse
 
christopherkade profile image
Christopher Kade

There's also this great tool to generate a README based on your package.json πŸ˜„ I use it for all of my projects

Collapse
 
scottydocs profile image
James.Scott

That's the one linked at the bottom (in the resources) πŸ˜‰

Collapse
 
christopherkade profile image
Christopher Kade

Aaah sorry I missed it ! Glad you did, it's super useful. Great article James πŸ˜„

Collapse
 
moopet profile image
Ben Sinclair • Edited

That's very specific for Github projects that fit in a fairly narrow window. I know the point of a template is that you use it as a starting point, but for most of the stuff I do, I'd be deleting more than half the template every time.

Collapse
 
douglasfugazi profile image
Douglas Fugazi

Thanks for your recommendation, it seems easy and helpful to work πŸ’ͺ