-
Notifications
You must be signed in to change notification settings - Fork 3
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: Update readme #55
base: main
Are you sure you want to change the base?
Conversation
- remove mention of using raw quinn, since that is no longer possible - consistently use upper case for QUIC and BLAKE3 - eliminate mention of collections. Collections are just one of many special cases of hash sequences. - remove mention of reexport that does not exist anymore
ac102a1
to
a1232f3
Compare
Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh-blobs/pr/55/docs/iroh_blobs/ Last updated: 2025-02-07T11:40:20Z |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a small suggestion.
|
||
This crate is usually used together with [iroh](https://crates.io/crates/iroh), but can also be used with normal [quinn](https://crates.io/crates/quinn) connections. Connection establishment is left up to the user or a higher level APIs such as the iroh CLI. | ||
This crate is used together with [iroh](https://crates.io/crates/iroh). Connection establishment is left up to the user or a higher level APIs such as the iroh CLI. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This crate is used together with [iroh](https://crates.io/crates/iroh). Connection establishment is left up to the user or a higher level APIs such as the iroh CLI. | |
This crate is used together with [iroh](https://crates.io/crates/iroh). Connection establishment is left up to the user or higher level APIs. |
Description
Breaking Changes
None
Notes & open questions
Note: the readme is also used from the iroh docs page. That is why I have a link to "this repository".
Change checklist