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

docs: add more usage detail to README #365

Merged
merged 1 commit into from
Aug 7, 2023
Merged

docs: add more usage detail to README #365

merged 1 commit into from
Aug 7, 2023

Conversation

kylehuntsman
Copy link
Contributor

@kylehuntsman kylehuntsman commented Jul 18, 2023

Updates the README to describe why and how one would use lassie via the CLI, HTTP API, and library.

Close #320.

Updates the README to describe why and how one would use lassie via the CLI, HTTP API, and library.
@kylehuntsman kylehuntsman added the documentation Improvements or additions to documentation label Jul 18, 2023
@codecov-commenter
Copy link

codecov-commenter commented Jul 18, 2023

Codecov Report

Merging #365 (b570a36) into main (af07584) will increase coverage by 1.29%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #365      +/-   ##
==========================================
+ Coverage   76.35%   77.65%   +1.29%     
==========================================
  Files          85       86       +1     
  Lines        6398     6506     +108     
==========================================
+ Hits         4885     5052     +167     
+ Misses       1241     1194      -47     
+ Partials      272      260      -12     

see 13 files with indirect coverage changes

Copy link
Collaborator

@hannahhoward hannahhoward left a comment

Choose a reason for hiding this comment

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

LGTM

@rvagg rvagg merged commit b8a6e78 into main Aug 7, 2023
@rvagg rvagg deleted the docs/usage branch August 7, 2023 05:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update readme to explain current functionality (not just Filecoin)
4 participants