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 simple file transfer example #21

Merged
merged 3 commits into from
Nov 29, 2024
Merged

Conversation

matheus23
Copy link
Member

@matheus23 matheus23 commented Nov 28, 2024

Description

Adds a simple example that basically rebuilds sendme, but simpler. No fancy clap interface, no progress bars, all in-memory blobs, copying stuff around needlessly.
But most importantly: It's very simple, just one function.


Also: I noticed there's an example-iroh feature that's enabled-by-default in blobs, which pulls in clap, indicativ and console. We probably don't want that in there, right?


I guess it would be nice to add some context about "Why am I doing this?": I'm thinking of linking to this from the quickstart guide of a new iroh docs page.

Breaking Changes

None

Notes & open questions

Only that I removed the example-iroh feature from the default feature set.

Change checklist

  • Self-review.
  • Documentation updates following the style guide, if relevant.
  • Tests if relevant.
  • All breaking changes documented.

@matheus23 matheus23 requested a review from rklaehn November 28, 2024 18:09
@matheus23 matheus23 self-assigned this Nov 28, 2024
Copy link

github-actions bot commented Nov 28, 2024

Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh-blobs/pr/21/docs/iroh_blobs/

Last updated: 2024-11-29T11:09:38Z

examples/transfer.rs Outdated Show resolved Hide resolved
@matheus23
Copy link
Member Author

Seems like there was some flakyness. I filed #22

@matheus23 matheus23 merged commit fd764fa into main Nov 29, 2024
23 of 24 checks passed
@matheus23 matheus23 deleted the matheus23/transfer-example branch November 29, 2024 11:20
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.

2 participants