Redo README.md

Question

Redo README.md

ansuz opened this issue 9 years ago · 6 comments

I wrote it off the top of my head, and would like some input.

Answer 1 · 2016-03-04T06:55:42.000Z

Sample json is missing contact field and requirement of using .k extension is missing.

Answer 2 · 2016-03-14T20:56:09.000Z

Contact field is now mentioned but structure of readme is just weird. nodeinfo has really almost nothing to do with data in this repo.

15:12 <@mk-fg> Also, I find structure of that document utterly confusing
...
15:15 <@mk-fg> Still, saying something like "this repo is a list of public peer credentials, which can be added here (in Nodeinfo.json format) by anyone via github PR" is like one sentence totally tying it all together

Answer 3 · 2016-03-15T06:12:43.000Z

To add: format is: valid JSON, space after colon, indentation using 4 spaces.

Answer 4 · 2016-06-19T08:25:42.000Z

added the .k requirement

Answer 5 · 2016-06-19T09:28:48.000Z

added formatting specifications to the readme

Answer 6 · 2016-06-19T09:37:51.000Z

It could still be improved, but I'm gonna close this anyway.