Adopt Standard Readme Style Spec

[davidak]

Have you considered adopting the Standard Readme Style Spec by @RichardLitt?

Practical that would mean having the required sections in your editable template. (see minimal-readme.md) Add your example content again.

After that, explain each section like here https://github.com/RichardLitt/standard-readme/blob/master/spec.md#sections

You can mention that it follows the Spec (with link) that members of the open source community has worked out and that one can add the badge if one follows it.

Your sections and their order are already very similar to the Standard Readme Style Spec, so this might not be too complicated. You have some additional, optional sections that make sense to me, like Visuals, Support, Roadmap and Project status, so you would need to collaborate with the other project to find consent to add them or remove them.

Would you like going this way? I could propose a Pull Request.

I opened a similar issue on their repo. (RichardLitt/standard-readme#82)

[RichardLitt]

I like this idea. Thanks for thinking of it, @davidak!

[dguo]

Hey @davidak, thanks for opening the issue.

I was aware of Standard Readme when I made this site, but I didn't make it a point of emphasis. My intention was to create an accessible resource that is primarily targeted towards people who are relatively new to writing READMEs (or who just haven't put that much thought into it before). I had my own ideas for what content goes into good READMEs, and I also didn't want to be rigid about it. As I noted in the FAQ: "Not all of the suggestions here will make sense for every project, so it's really up to the developers what information should be included in the README." I should add a link to Standard Readme there, but from what I can tell, it's pretty far from becoming a true standard in terms of adoption.

I'd prefer to hold off on making compliance with it a goal until the linked issue gets more traction.

[davidak]

The last days i thought about how we can help projects to create better readmes. It's great when a community comes up with a standard and adopt it, like the JS community and the IPFS project does with the linked spec, but for me, my company and many more small projects, the spec is too verbose. I actually don't care if my readme is compliant to any spec. This site is much more accessible, so the chance people consider using it is much higher.

So i close this issue, but i will open others too discuss using sections and section order from the spec.