You work hard to put together projects that you share with the world live and on Github/Codepen/Codesandbox in hope one day to show potential emplo...
For further actions, you may consider blocking this person and/or reporting abuse
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.
This Postwoman's README is slick! Great example.
Thank you 😄
Thank you for this post!
Usually, I used README only as an instruction 'How to run ...'. I saw others
README, but didn't much pay attention to the ways of how they formate it.s README file, to make it more readable and full.So I will try tips, which you provided, in my next project
I wrote almost the same blog, Love it though
Oh wow, yes. Love your post, more detailed and structured. Bookmarked. Glad I didn't see it first, it might have scared me off from writing my first post :)
Great tips, Nick! I also try to add code coverage, CI, and documentation badges to any of my serious projects.
Bookmarked!
Indeed, a well designed Readme is necessary for an open source software. To go further, here is a well-known list of awesome readme: github.com/matiassingers/awesome-r...