Skip to content

Commit 22bc8ce

Browse files
immanuwellmxpv
authored andcommitted
docs(shim-protos): fix stale README commands
1 parent 7847295 commit 22bc8ce

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

crates/shim-protos/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ edit those auto-generated source files.
2525

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

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

3434
```toml
3535
[dependencies]
36-
containerd-shim-protos = "0.4"
36+
containerd-shim-protos = "0.11"
3737
```
3838

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

7171
# build async connect, client and server
72-
$ cargo build --example shim-proto-connect-async --features async
73-
$ cargo build --example shim-proto-client-async --features async
74-
$ cargo build --example shim-proto-server-async --features async
72+
$ cargo build -p containerd-shim-protos --example shim-proto-connect-async --features async
73+
$ cargo build -p containerd-shim-protos --example shim-proto-client-async --features async
74+
$ cargo build -p containerd-shim-protos --example shim-proto-server-async --features async
7575
```

0 commit comments

Comments
 (0)