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: Iroh examples #1237

Merged
merged 8 commits into from
Jul 14, 2023
Merged

docs: Iroh examples #1237

merged 8 commits into from
Jul 14, 2023

Conversation

rklaehn
Copy link
Contributor

@rklaehn rklaehn commented Jul 14, 2023

Description

Add a minimal example to spin up an iroh node and serve a single blob.
Also an example to share a collection from memory.

Do examples count as docs?

Change checklist

  • Self-review.
  • Documentation updates if relevant.

Implements #1236

rklaehn added 2 commits July 14, 2023 10:57
also implement tickets for single blobs so we can make a ticket for the example
@rklaehn rklaehn changed the title Iroh examples docs: Iroh examples Jul 14, 2023
@rklaehn rklaehn marked this pull request as ready for review July 14, 2023 09:37
@rklaehn rklaehn mentioned this pull request Jul 14, 2023
@rklaehn rklaehn requested a review from b5 July 14, 2023 12:26
@@ -0,0 +1,63 @@
//! An example that serves an iroh collection from memory.
Copy link
Member

Choose a reason for hiding this comment

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

I've added suggested changes to this file in a branch: https://github.com/n0-computer/iroh/tree/b5/iroh-examples

PTAL, and feel free to cherry-pick 331ea3a

Copy link
Member

@b5 b5 left a comment

Choose a reason for hiding this comment

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

After some small patches, LGTM!

@b5 b5 merged commit 1cfa183 into main Jul 14, 2023
@ramfox ramfox deleted the iroh-examples branch July 14, 2023 23:17
matheus23 pushed a commit that referenced this pull request Nov 14, 2024
* add minimal example to run an iroh node sharing a single blob, and serve an entire collection
* examples are structured as independent crates so we can specify features
* also implement tickets for single blobs so we can make a ticket for the example

---------

Co-authored-by: b5 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants