docs: update root, iroh, iroh-metrics readmes (#1258)

* docs: update readme.md
* docs: iroh crate readme
* add very basic iroh-metrics README

Author: b5

Diff for: .img/iroh_wordmark.svg

@@ -1,11 +1,7 @@
-<h1 align="center">iroh</h1>
-<div align="center">
- <strong>
-   IPFS reimagined.
- </strong>
-</div>
+<img alt="iroh" src="./.img/iroh_wordmark.svg" width="100" />
+https://iroh.computer
 
-<br />
+Bytes, Distributed.
 
 <div align="center">
   <!-- Crates version -->
@@ -27,8 +23,12 @@
 
 <div align="center">
   <h3>
+    <a href="https://iroh.computer/docs">
+      Docs Site
+    </a>
+    <span> | </span>
     <a href="https://docs.rs/iroh">
-      API Docs
+      Rust Docs
     </a>
     <span> | </span>
     <a href="https://github.com/n0-computer/iroh/releases">
@@ -38,25 +38,17 @@
 </div>
 <br/>
 
-## Usage
+Iroh is a protocol for syncing & moving bytes. Bytes of any size, on any device. At it's 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.
 
-### Cli
-Sending data
-```sh
-$ ./iroh provide <file>
-```
+## Using Iroh
 
-Receiving data
-```sh
-$ ./iroh get <hash>
-```
+Iroh is delivered as a Rust library and a CLI. Run `cargo build` to build the `iroh` CLI. To use iroh in your project, check out https://iroh.computer/install to get started.
 
 ### As a library
 Disable default features when using `iroh` as a library:
 `iroh = { version: "...", default-features = false }`
 
-This removes dependencies that are only relevant when using `iroh` as
-a cli.
+This removes dependencies that are only relevant when using `iroh` as a cli.
 
 # License
 

Diff for: README.md

@@ -0,0 +1,22 @@
+# iroh-metrics
+
+Metrics collection for iroh. It keeps the "glue" necessary to expose metrics defined metrics for collection: an HTTP server that exposes tracked metrics that a service like prometheus can poll for recording.
+
+Nearly all metrics in iroh are recorded as simple counters.
+
+# License
+
+This project is licensed under either of
+
+ * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
+   http://www.apache.org/licenses/LICENSE-2.0)
+ * MIT license ([LICENSE-MIT](LICENSE-MIT) or
+   http://opensource.org/licenses/MIT)
+
+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.

Diff for: iroh-metrics/README.md

@@ -3,7 +3,7 @@ name = "iroh"
 version = "0.4.1"
 edition = "2021"
 readme = "README.md"
-description = "IPFS reimagined"
+description = "Bytes. Distributed."
 license = "MIT/Apache-2.0"
 authors = ["dignifiedquire <[email protected]>", "n0 team"]
 repository = "https://github.com/n0-computer/iroh"

Diff for: iroh/Cargo.toml

@@ -1,5 +1,25 @@
 # iroh
 
+The iroh crate defines both the `iroh` library and `iroh` command-line interface (CLI).
+
+For more details on Iroh, see https://iroh.computer.
+
+## Building the CLI
+
+Simply run `cargo build` from the project root, it produces the `iroh` CLI by default.
+
+## Using as a rust crate
+
+Because iroh builds the CLI by default, you should disable `default-features` when importing the `iroh` crate via cargo:
+
+```toml
+[dependencies]
+iroh = { version: "...", default-features = false }
+```
+
+## Running Examples
+
+examples are located in `iroh/examples`. Some have their own cargo.toml to show different use cases, and as such are shipped as their own packages. For these run them with `cargo run --package`. eg: `cargo run --package hello-world`
 
 # License