|
1 | 1 | <h1 align="center"><a href="https://iroh.computer"><img alt="iroh" src="./.img/iroh_wordmark.svg" width="100" /></a></h1> |
2 | 2 |
|
3 | 3 | <h3 align="center"> |
4 | | -A toolkit for building distributed applications |
| 4 | +An iroh protocol for moving bytes over the internet |
5 | 5 | </h3> |
6 | 6 |
|
7 | | -[](https://docs.rs/iroh/) |
8 | | -[](https://crates.io/crates/iroh) |
9 | | -[](https://crates.io/crates/iroh) |
| 7 | +[](https://docs.rs/iroh-blobs/) |
| 8 | +[](https://crates.io/crates/iroh-blobs) |
| 9 | +[](https://crates.io/crates/iroh-blobs) |
10 | 10 | [](https://discord.com/invite/DpmJgtU7cW) |
11 | 11 | [](https://www.youtube.com/@n0computer) |
12 | 12 | [](LICENSE-MIT) |
13 | 13 | [](LICENSE-APACHE) |
14 | | -[](https://github.com/n0-computer/iroh/actions/workflows/ci.yml) |
| 14 | +[](https://github.com/n0-computer/iroh-blobs/actions/workflows/ci.yml) |
15 | 15 |
|
16 | 16 | <div align="center"> |
17 | 17 | <h3> |
18 | 18 | <a href="https://iroh.computer/docs"> |
19 | 19 | Docs Site |
20 | 20 | </a> |
21 | 21 | <span> | </span> |
22 | | - <a href="https://docs.rs/iroh"> |
| 22 | + <a href="https://docs.rs/iroh-blobs"> |
23 | 23 | Rust Docs |
24 | 24 | </a> |
25 | | - <span> | </span> |
26 | | - <a href="https://github.com/n0-computer/iroh/releases"> |
27 | | - Releases |
28 | | - </a> |
29 | 25 | </h3> |
30 | 26 | </div> |
31 | 27 | <br/> |
32 | 28 |
|
33 | | -## Features |
34 | | - |
35 | | -- Documents - Authors create and join documents: mutable key-value stores that multiple users read from, write to, and sync with, subscribing to live updates in real time. |
36 | | -- Blobs - Iroh works with content-addressed blobs of opaque data, which are often the bytes of a file. |
37 | | -- Networking - At the core of iroh is the ability to connect any two devices, no matter where they are. |
38 | | - |
39 | | -## Overview |
40 | | - |
41 | | -Iroh is a protocol for syncing & moving bytes. Bytes of any size, on any device. At its core, it's a peer-2-peer network built on a _magic socket_ that establishes [QUIC](https://en.wikipedia.org/wiki/QUIC) connections between peers. Peers request and provide _blobs_ of opaque bytes that are incrementally verified by their BLAKE3 hash during transfer. |
42 | | - |
43 | | -## Getting Started |
44 | | - |
45 | | -Iroh is delivered as a Rust library and a CLI. |
46 | | - |
47 | | -### Library |
48 | | - |
49 | | -Run `cargo add iroh`, to add `iroh` to your project. |
50 | | - |
51 | | -### CLI |
52 | | - |
53 | | -Check out https://iroh.computer/docs/install to get started. |
54 | | - |
55 | | -The implementation lives in the `iroh-cli` crate. |
56 | | - |
57 | | -### Links |
58 | | - |
59 | | -- [Introducing Iroh (video)](https://www.youtube.com/watch?v=RwAt36Xe3UI_) |
60 | | -- [Iroh Examples](https://github.com/n0-computer/iroh-examples) |
61 | | - |
62 | | - |
63 | 29 | ## License |
64 | 30 |
|
65 | 31 | Copyright 2024 N0, INC. |
|
0 commit comments