Skip to content

Commit

Permalink
[docs] fix documents for Install
Browse files Browse the repository at this point in the history
  • Loading branch information
Littlefisher619 committed Mar 8, 2023
1 parent eca151e commit 6a63ce8
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@ It also enables developers to write eBPF programs in familiar languages like `C/

### 📦 Install wasm-bpf

Run the following command to install the `wasm-bpf` CLI tool:

```sh
cargo install wasm-bpf
```

### Running a standalone Wasm-eBPF program

Running the `runqlat` example with docker:
Expand Down Expand Up @@ -62,7 +68,13 @@ For more tools to distribute and deploy Wasm-eBPF programs for usecases from `Ob

### Embed a Wasm-eBPF function in your program

Add the following line to your Cargo.toml to use Wasm-bpf as a `library`:

```toml
wasm-bpf-rs = "0.2.1"
```

See the [main.rs](runtime/cmd/src/main.rs) for an example of how to use the `wasm-bpf-rs` library.

## Features

Expand Down
2 changes: 1 addition & 1 deletion runtime/cmd/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ anyhow = "1.0.69"
clap = { version = "4.1.4", features = ["derive"] }
flexi_logger = "0.25.1"
log = "0.4.17"
wasm-bpf-rs = { path = "../wasm-bpf-rs", version = "0.2.0" }
wasm-bpf-rs = { path = "../wasm-bpf-rs", version = "0.2.1" }

0 comments on commit 6a63ce8

Please sign in to comment.