Skip to content

docs(shim-protos): fix stale README commands #476

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

Merged
mxpv merged 1 commit into from
Jun 20, 2026
Merged

docs(shim-protos): fix stale README commands #476

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
20 changes: 10 additions & 10 deletions crates/shim-protos/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ edit those auto-generated source files.

If upgrading/modification is needed, please follow the steps:
- Synchronize the latest protobuf source files from the upstream projects into directory 'vendor/'.
- Re-generate the source files by `cargo build --features=generate_bindings`.
- Re-generate the source files by building this crate, e.g. `cargo build -p containerd-shim-protos`.
- Commit the synchronized protobuf source files and auto-generated source files, keeping them in synchronization.

## Usage
Add `containerd-shim-client` as a dependency in your `Cargo.toml`
Add `containerd-shim-protos` as a dependency in your `Cargo.toml`

```toml
[dependencies]
containerd-shim-protos = "0.4"
containerd-shim-protos = "0.11"
```

Basic client code looks as follows:
Expand Down Expand Up @@ -63,13 +63,13 @@ let resp = task_client.connect(context, &req).expect("Connect request failed");
The way to build the example:
```bash
# build sync connect, client and server
$ cargo build --example shim-proto-connect
$ sudo ./shim-proto-connect unix:///containerd-shim/shim_socket_path.sock
$ cargo build --example shim-proto-client
$ cargo build --example shim-proto-server
$ cargo build -p containerd-shim-protos --example shim-proto-connect
$ sudo ./target/debug/examples/shim-proto-connect unix:///containerd-shim/shim_socket_path.sock
$ cargo build -p containerd-shim-protos --example shim-proto-client
$ cargo build -p containerd-shim-protos --example shim-proto-server

# build async connect, client and server
$ cargo build --example shim-proto-connect-async --features async
$ cargo build --example shim-proto-client-async --features async
$ cargo build --example shim-proto-server-async --features async
$ cargo build -p containerd-shim-protos --example shim-proto-connect-async --features async
$ cargo build -p containerd-shim-protos --example shim-proto-client-async --features async
$ cargo build -p containerd-shim-protos --example shim-proto-server-async --features async
```
Loading