Skip to content

Commit a1232f3

Browse files
committed
Update readme
- 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
1 parent 5d67f47 commit a1232f3

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
# iroh-blobs
22

3-
This crate provides blob and collection transfer support for iroh. It implements a simple request-response protocol based on blake3 verified streaming.
3+
This crate provides blob and blob sequence transfer support for iroh. It implements a simple request-response protocol based on BLAKE3 verified streaming.
44

5-
A request describes data in terms of blake3 hashes and byte ranges. It is possible to
6-
request blobs or ranges of blobs, as well as collections.
5+
A request describes data in terms of BLAKE3 hashes and byte ranges. It is possible to request blobs or ranges of blobs, as well as entire sequences of blobs in one request.
76

8-
The requester opens a quic stream to the provider and sends the request. The provider answers with the requested data, encoded as [blake3](https://github.com/BLAKE3-team/BLAKE3-specs/blob/master/blake3.pdf) verified streams, on the same quic stream.
7+
The requester opens a QUIC stream to the provider and sends the request. The provider answers with the requested data, encoded as [BLAKE3](https://github.com/BLAKE3-team/BLAKE3-specs/blob/master/blake3.pdf) verified streams, on the same QUIC stream.
98

10-
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.
9+
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.
1110

1211
## Concepts
1312

1413
- **Blob:** a sequence of bytes of arbitrary size, without any metadata.
1514

16-
- **Link:** a 32 byte blake3 hash of a blob.
15+
- **Link:** a 32 byte BLAKE3 hash of a blob.
1716

1817
- **HashSeq:** a blob that contains a sequence of links. Its size is a multiple of 32.
1918

@@ -64,8 +63,7 @@ async fn main() -> anyhow::Result<()> {
6463

6564
## Examples
6665

67-
Examples that use `iroh-blobs` can be found in the `iroh` crate. the iroh crate publishes `iroh_blobs` as `iroh::bytes`.
68-
66+
Examples that use `iroh-blobs` can be found in [this repo](https://github.com/n0-computer/iroh-blobs/tree/main/examples).
6967

7068
# License
7169

0 commit comments

Comments
 (0)