Skip to content

Commit

Permalink
Merge branch 'main' into flub/remove-rebind
Browse files Browse the repository at this point in the history
  • Loading branch information
flub committed Mar 15, 2024
2 parents daa137e + 8d86ffc commit 675f4c5
Show file tree
Hide file tree
Showing 39 changed files with 428 additions and 1,985 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ jobs:

- name: Check MSRV all features
run: |
cargo +$MSRV check --workspace --all-targets --features cli
cargo +$MSRV check --workspace --all-targets
cargo_deny:
timeout-minutes: 30
Expand Down
158 changes: 129 additions & 29 deletions Cargo.lock

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

3 changes: 2 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ members = [
"iroh-net",
"iroh-sync",
"iroh-test",
"iroh-net/bench"
"iroh-net/bench",
"iroh-cli"
]
resolver = "2"

Expand Down
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,17 +42,21 @@ Iroh is a protocol for syncing & moving bytes. Bytes of any size, on any device.

## Using Iroh

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/docs/install to get started.
Iroh is delivered as a Rust library and a CLI.

### As a library
Disable default features when using `iroh` as a library:
`iroh = { version = "...", default-features = false }`
### Library

This removes dependencies that are only relevant when using `iroh` as a cli.
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.

# License

Copyright 2023 N0, INC.
Copyright 2024 N0, INC.

This project is licensed under either of

Expand Down
Loading

0 comments on commit 675f4c5

Please sign in to comment.