Skip to content

Commit

Permalink
chore(docs): update readme (#2465)
Browse files Browse the repository at this point in the history
## Description

Is the tagline correct?
Can we enable this discord widget?

## Breaking Changes

<!-- Optional, if there are any breaking changes document them,
including how to migrate older code. -->

## Notes & open questions

<!-- Any notes, remarks or open questions you have to make about the PR.
-->

## Change checklist

- [ ] Self-review.
- [ ] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.
- [ ] Tests if relevant.
- [ ] All breaking changes documented.
  • Loading branch information
Arqu committed Jul 8, 2024
1 parent 203f9e7 commit 61f3f7e
Showing 1 changed file with 29 additions and 25 deletions.
54 changes: 29 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,17 @@
<img alt="iroh" src="./.img/iroh_wordmark.svg" width="100" />
https://iroh.computer
<h1 align="center"><a href="https://iroh.computer"><img alt="iroh" src="./.img/iroh_wordmark.svg" width="100" /></a></h1>

Bytes, Distributed.
<h3 align="center">
A toolkit for building distributed applications
</h3>

<div align="center">
<!-- Crates version -->
<a href="https://crates.io/crates/iroh">
<img src="https://img.shields.io/crates/v/iroh.svg?style=flat-square"
alt="Crates.io version" />
</a>
<!-- Downloads -->
<a href="https://crates.io/crates/iroh">
<img src="https://img.shields.io/crates/d/iroh.svg?style=flat-square"
alt="Download" />
</a>
<!-- docs.rs docs -->
<a href="https://docs.rs/iroh">
<img src="https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square"
alt="docs.rs docs" />
</a>
</div>
[![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)
[![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)

<div align="center">
<h3>
Expand All @@ -38,9 +30,17 @@ Bytes, Distributed.
</div>
<br/>

## 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.

## Using Iroh
## Getting Started

Iroh is delivered as a Rust library and a CLI.

Expand All @@ -54,7 +54,13 @@ Check out https://iroh.computer/docs/install to get started.

The implementation lives in the `iroh-cli` crate.

# License
### 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.

Expand All @@ -69,6 +75,4 @@ at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this project by you, as defined in the Apache-2.0 license,
shall be dual licensed as above, without any additional terms or conditions.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

0 comments on commit 61f3f7e

Please sign in to comment.