Use standard README

Question

Use standard README

Stebalien opened this issue 5 years ago · 3 comments

We should use the standard readme that we use in all other go-ipfs packages.

Answer 1 · 2020-04-16T16:00:34.000Z

Is there a template or are we just using https://github.com/RichardLitt/standard-readme ?

Answer 2 · 2020-04-16T16:24:19.000Z

We're just copying the readme from repo to repo. I don't believe that there is a standard source of truth at this point.

Ideally, we'd have a source of truth and a github action to deploy changes to all repos...

Answer 3 · 2020-05-13T08:48:53.000Z

In #17 there was an update that made it conform to standard README and it adds the majority of the elements I see on other READMEs. Hopefully this is good enough for now. Please shout if there's something big I missed :)