README stored on disk is out of date/confusing #103
Labels
exp/intermediate
Prior experience is likely helpful
kind/bug
A bug in existing code (including security flaws)
P2
Medium: Good to have, but can wait until someone steps up
topic/docs
Documentation
The README is misleading
go-ds-flatfs/readme.go
Lines 3 to 33 in f075020
FlatFS does not know anything about CIDs, blocks or IPLD and actually is being used by different projects in the ecosystem in different ways. In particular some key their IPLD blocks by CIDs and some by multihashes, but FlatFS doesn't really care. All the text around base32 encoding, CIDs, etc. should be removed and placed into the docs of the applications that use them (e.g. go-ipfs docs).
The text was updated successfully, but these errors were encountered: