DEV Community

Discussion on: Add this to your project's README for maximum impact

Collapse
 
daviddalbusco profile image
David Dal Busco

Thank you for sharing this list!

In our case one information which was often requested to be added was a CONTRIBUTING guide to our project. If that's maybe too much information to be displayed in the README, it's probably good to link or reference it too.

Badges from Shields.io is a good way to summarize info too. I recently landed on the Postwoman project's README and I think it's a nice usage of badges. Notably the way they display the last release date, which would match your good idea of displaying TIMESTAMP.

[![GitHub release](https://img.shields.io/github/release/yourproject/all?logo=GitHub)](https://github.com/yourproject/releases/latest)
Collapse
 
usaspiff profile image
Nick Tchemitcheff

This Postwoman's README is slick! Great example.

Collapse
 
liyasthomas profile image
Liyas Thomas

Thank you 😄