celestiaorg / go-header

Go library with all the services needed to request, sync and store blockchain headers.
Apache License 2.0
17 stars 16 forks source link

Question: from either the p2p network... #61

Closed rootulp closed 12 months ago

rootulp commented 1 year ago

https://github.com/celestiaorg/go-header/blob/bdd5069fd955857d036152bacd42c3f3f4a235c0/README.md?plain=1#L15-L16

What is the other location? "from either the P2P network" seems incomplete.

Wondertan commented 1 year ago

@rootulp, the documentation of this repository is definitely weak, unlike the features the repository provides. I really wish to have time and document everything thoroughly with some design doc, but for now, we only have more or less well-documented code, see Syncer for example.

Regarding the question, I think the "either" part should just be removed, and then the sentence starts to make sense, as I can't think of a different option there besides P2P.

Mind for a quick PR fix?