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 and fix version mismatch #21

Merged
merged 5 commits into from
Jan 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "iroh-doctor"
version = "0.1.0"
version = "0.31.0"
edition = "2021"
readme = "README.md"
description = "Diagnose and test iroh in your network configuration"
Expand Down
53 changes: 30 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
<h1 align="center"><a href="https://iroh.computer"><img alt="iroh" src="./.img/iroh_wordmark.svg" width="100" /></a></h1>
<h1 align="center"><a style="color:rgb(124 124 255)" href="https://iroh.computer">iroh-doctor</a></h1>

<h3 align="center">
A toolkit for building distributed applications
Test your network.
</h3>

[![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-doctor/)
[![Crates.io](https://img.shields.io/crates/v/iroh.svg?style=flat-square)](https://crates.io/crates/iroh-doctor)
[![downloads](https://img.shields.io/crates/d/iroh.svg?style=flat-square)](https://crates.io/crates/iroh-doctor)
[![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 @@ -30,35 +29,43 @@ A toolkit for building distributed applications
</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.
iroh-doctor is a tool used for diagnosing network issues with [iroh](https://github.com/n0-computer/iroh).

## Getting Started

Iroh is delivered as a Rust library and a CLI.

### Library
Run `cargo install iroh-doctor` or build from source.

Run `cargo add iroh`, to add `iroh` to your project.
```shell
Usage: iroh-doctor [OPTIONS] <COMMAND>

### CLI
Commands:
report Report on the current network environment, using either an explicitly provided stun host or the settings from the config file
accept Wait for incoming requests from iroh doctor connect
connect Connect to an iroh doctor accept node
port-map-probe Probe the port mapping protocols
port-map Attempt to get a port mapping to the given local port
relay-urls Get the latencies of the different relay url
plot Plot metric counters
help Print this message or the help of the given subcommand(s)

Check out https://iroh.computer/docs/install to get started.
Options:
--config <CONFIG>
Path to the configuration file, see https://iroh.computer/docs/reference/config

The implementation lives in the `iroh-cli` crate.
--metrics-addr <METRICS_ADDR>
Address to serve metrics on. Disabled by default

### Links
--metrics-dump-path <METRICS_DUMP_PATH>
Write metrics in CSV format at 100ms intervals. Disabled by default

- [Introducing Iroh (video)](https://www.youtube.com/watch?v=RwAt36Xe3UI_)
- [Iroh Examples](https://github.com/n0-computer/iroh-examples)
-h, --help
Print help (see a summary with '-h')

-V, --version
Print version
```

## License

Expand Down
Loading