Feat/module docs #83

[shannonwells]

Documentation pass for modules in this repo.

• Add README.md to root of each package, filestore, pieceio, piecestore, retrievalmarket, and storagemarket
• Link to READMEs on main README
• Write interface implementation documentation for storagemarket and retrievalmarket
• Write a little bit about filestore, pieceio, and piecestore.

Request

I would appreciate feedback or even better, more detailed content on the storagemarket module since I don't know it as well as retrieval.

[codecov-commenter]

Codecov Report

Merging #267 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #267   +/-   ##
=======================================
  Coverage   64.86%   64.86%           
=======================================
  Files          40       40           
  Lines        2342     2342           
=======================================
  Hits         1519     1519           
  Misses        699      699           
  Partials      124      124           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2132c05...2132c05. Read the comment docs.

[hannahhoward]

Submitting these comments early even though it's not ready for review:

Generally the storage & retrieval modules are headed in the right direction, and I just have some suggestions for additional information.

I'm also going to tag @mishmosh on this as someone with experience in documentation.

[mishmosh]

Latest changes address all of my comments, thanks! Please wait for @hannahhoward’s green check too before merging though.

[ingar]

I have a handful of slight changes that might clarify things, and some syntactical nits.

[hannahhoward]

Honestly, THIS PR IS AWESOME. LGTM++++

[hannahhoward]

Would add the following:

Suggested change

	The `filestore` module is a simple wrapper for os.File. It is used by [pieceio](../pieceio),
	[retrievialmarket](../retrievalmarket), and [storagemarket](../storagemarket).
	The `filestore` module is a simple wrapper for os.File. It's primary purpose to wrap a specific local directory configured by the node. It is used by [pieceio](../pieceio),
	[retrievialmarket](../retrievalmarket), and [storagemarket](../storagemarket).