Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #120

Merged
merged 3 commits into from
Feb 11, 2020
Merged

Update README #120

merged 3 commits into from
Feb 11, 2020

Conversation

mishmosh
Copy link
Collaborator

  • list & add one-liner description for each component
  • stub a Usage section, for a future PR

- list & add one-liner description for each component
- stub a Usage section, for a future PR
README.md Outdated

**Requires go 1.13**

Install the module in your package or app with `go get "github.com/filecoin-project/go-fil-markets/filmarkets"`
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is probably wrong, @shannonwells please correct :)

@codecov-io
Copy link

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #120   +/-   ##
=======================================
  Coverage   35.26%   35.26%           
=======================================
  Files          43       43           
  Lines        3279     3279           
=======================================
  Hits         1156     1156           
  Misses       1791     1791           
  Partials      332      332

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 e6b87a8...e282563. Read the comment docs.

Copy link
Contributor

@shannonwells shannonwells left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggested change

README.md Outdated

**Requires go 1.13**

Install the module in your package or app with `go get "github.com/filecoin-project/go-fil-markets/filmarkets"`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Install the go-fil-markets module that you want to use. Available modules are:

  • filestore
  • pieceio
  • piecestore
  • retrievalmarket
  • storagemarket

Install with:
go get "github.com/filecoin-project/go-fil-markets/<module>"

@mishmosh mishmosh merged commit 7137a9d into master Feb 11, 2020
@mishmosh mishmosh deleted the mishmosh/readme branch February 11, 2020 20:44
@dirkmc dirkmc mentioned this pull request Dec 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants