From ecf26915e62488506bdcf2adc2e8032713230b6d Mon Sep 17 00:00:00 2001 From: Ruediger Klaehn Date: Tue, 22 Oct 2024 12:18:07 +0300 Subject: [PATCH] chore: Update and fix readme --- .img/iroh_wordmark.svg | 1 + README.md | 46 ++++++------------------------------------ 2 files changed, 7 insertions(+), 40 deletions(-) create mode 100644 .img/iroh_wordmark.svg diff --git a/.img/iroh_wordmark.svg b/.img/iroh_wordmark.svg new file mode 100644 index 00000000..9dff077f --- /dev/null +++ b/.img/iroh_wordmark.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/README.md b/README.md index 710628c5..ab42a066 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@

iroh

-A toolkit for building distributed applications +An iroh protocol for moving bytes over the internet

-[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square)](https://docs.rs/iroh/) -[![Crates.io](https://img.shields.io/crates/v/iroh.svg?style=flat-square)](https://crates.io/crates/iroh) -[![downloads](https://img.shields.io/crates/d/iroh.svg?style=flat-square)](https://crates.io/crates/iroh) +[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square)](https://docs.rs/iroh-blobs/) +[![Crates.io](https://img.shields.io/crates/v/iroh.svg?style=flat-square)](https://crates.io/crates/iroh-blobs) +[![downloads](https://img.shields.io/crates/d/iroh.svg?style=flat-square)](https://crates.io/crates/iroh-blobs) [![Chat](https://img.shields.io/discord/1161119546170687619?logo=discord&style=flat-square)](https://discord.com/invite/DpmJgtU7cW) [![Youtube](https://img.shields.io/badge/YouTube-red?logo=youtube&logoColor=white&style=flat-square)](https://www.youtube.com/@n0computer) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](LICENSE-MIT) [![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat-square)](LICENSE-APACHE) -[![CI](https://github.com/n0-computer/iroh/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/n0-computer/iroh/actions/workflows/ci.yml) +[![CI](https://github.com/n0-computer/iroh/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/n0-computer/iroh-blobs/actions/workflows/ci.yml)

@@ -19,47 +19,13 @@ A toolkit for building distributed applications Docs Site | - + Rust Docs - | - - Releases -


-## Features - -- 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. -- Blobs - Iroh works with content-addressed blobs of opaque data, which are often the bytes of a file. -- Networking - At the core of iroh is the ability to connect any two devices, no matter where they are. - -## Overview - -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. - -## Getting Started - -Iroh is delivered as a Rust library and a CLI. - -### Library - -Run `cargo add iroh`, to add `iroh` to your project. - -### CLI - -Check out https://iroh.computer/docs/install to get started. - -The implementation lives in the `iroh-cli` crate. - -### Links - -- [Introducing Iroh (video)](https://www.youtube.com/watch?v=RwAt36Xe3UI_) -- [Iroh Examples](https://github.com/n0-computer/iroh-examples) - - ## License Copyright 2024 N0, INC.