hyperboria / peers

A geographically sorted list of public peering credentials for joining Hyperboria

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Redo README.md

ansuz opened this issue · comments

commented

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

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

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

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

commented

added formatting specifications to the readme

commented

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