Skip to content

Commit

Permalink
docs: update proto notice (#224)
Browse files Browse the repository at this point in the history
Signed-off-by: mikeee <[email protected]>
  • Loading branch information
mikeee authored Aug 21, 2024
1 parent 0a0efaa commit 7a508be
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ resiliency.

Ensure you have Rust version 1.78 or higher installed. If not, install Rust [here](https://www.rust-lang.org/tools/install).

You will also need to install [protoc](https://github.com/protocolbuffers/protobuf#protobuf-compiler-installation).

## How to use

Add the following to your `Cargo.toml` file:
Expand Down Expand Up @@ -84,8 +82,6 @@ To build the SDK run:
cargo build
```

>Note: The protobuf client generation is built into `cargo build` process so updating the proto files under `dapr/` is enough to update the protobuf client.
## Developing (Updating .proto files from upstream Dapr)

To fetch the latest .proto files from Dapr execute the script `update-protos.sh`:
Expand All @@ -100,6 +96,8 @@ By default, the script fetches the latest proto updates from the master branch o
./update-protos.sh -v v1.14.0
```

You will also need to install [protoc](https://github.com/protocolbuffers/protobuf#protobuf-compiler-installation).

Protos can then be compiled using:

```bash
Expand Down
2 changes: 1 addition & 1 deletion dapr/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ edition.workspace = true
license.workspace = true
repository.workspace = true
description = "Rust SDK for dapr"
readme = "../README.md"
readme = "README.md"
keywords = ["microservices", "dapr"]
rust-version.workspace = true

Expand Down

0 comments on commit 7a508be

Please sign in to comment.