Skip to content

Add details to quickstart about using bao-tree #413

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add details to quickstart about using bao-tree #413

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 22 additions & 1 deletion src/app/docs/quickstart/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,28 @@ If you're ever confused about what to import, take a look at the imports in the

We'll assume you've set up [rust](https://www.rust-lang.org/) and [cargo](https://doc.rust-lang.org/cargo/) on your machine.

Initialize a new project by running `cargo init file-transfer`, then `cd file-transfer` and install all the packages we're going to use: `cargo add iroh iroh-blobs tokio anyhow`.
Initialize a new project by running `cargo init file-transfer`, then
`cd file-transfer`.

Then, install all the packages we're going to use:

`cargo add iroh iroh-blobs tokio anyhow bao-tree`

Your Cargo.toml should look like this:

```toml
[package]
name = "file-transfer"
version = "0.1.0"
edition = "2024"

[dependencies]
anyhow = "1.0.100"
iroh = "0.94.0" # make sure to use the latest version
iroh-blobs = "0.96.0" # make sure to use the latest version
bao-tree = { version = "0.15", features = ["fs"] }
tokio = "1.48.0"
```

From here on we'll be working inside the `src/main.rs` file.

Expand Down
Loading