docs(iroh): improve readme#4329
Merged
Merged
Conversation
|
Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/4329/docs/iroh/ Last updated: 2026-06-11T14:03:00Z |
| @@ -1,87 +1,149 @@ | |||
| # iroh | |||
Contributor
There was a problem hiding this comment.
while we are at it, maybe we should replicate the logo and our badges from the main readme?
flub
reviewed
Jun 11, 2026
flub
left a comment
flub
left a comment
Contributor
There was a problem hiding this comment.
nice! thanks for giving this some attention!
| A connection is usually established with the help of a *relay server*. When an | ||
| endpoint is created it connects to the closest relay and designates it as its | ||
| *home relay*. Other endpoints reach it first through this relay, then both | ||
| sides attempt a direct connection using [QUIC Address Discovery][QAD] and hole |
Contributor
There was a problem hiding this comment.
both sides use QUIC Nat Traversal to establish a direct connection.
| const ALPN: &[u8] = b"iroh-example/echo/0"; | ||
|
|
||
| #[tokio::main] | ||
| async fn main() -> n0_error::Result<()> { |
Contributor
There was a problem hiding this comment.
does it make sense to write the example using anyhow here to not scare people away from thinking they have to buy into a weird error lib?
flub
approved these changes
Jun 11, 2026
matheus23
approved these changes
Jun 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The README of the iroh crate is the first thing people see on https://crates.io/crates/iroh or https://lib.rs/iroh, and we should improve it.
Right now it mostly talks about structured events, which is a very minor thing in the grand scheme of things. And it has no code example.
This PR improves the README. Happy to discuss or iterate.