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: Update readme #55

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Update readme #55

wants to merge 1 commit into from

Conversation

rklaehn
Copy link
Collaborator

@rklaehn rklaehn commented Feb 7, 2025

Description

  • 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

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

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

- 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
@rklaehn rklaehn changed the title Update readme docs: Update readme Feb 7, 2025
Copy link

github-actions bot commented Feb 7, 2025

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

Copy link
Member

@matheus23 matheus23 left a 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.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🏗 In progress
Development

Successfully merging this pull request may close these issues.

2 participants