From 7a508beaea37aa45c3aa79fdd44d1c85f0a70059 Mon Sep 17 00:00:00 2001 From: Mike Nguyen Date: Wed, 21 Aug 2024 12:52:53 +0100 Subject: [PATCH] docs: update proto notice (#224) Signed-off-by: mikeee --- README.md | 6 ++---- dapr/Cargo.toml | 2 +- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a4c165ca..f0f01b1e 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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`: @@ -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 diff --git a/dapr/Cargo.toml b/dapr/Cargo.toml index e9b63db7..5692a870 100644 --- a/dapr/Cargo.toml +++ b/dapr/Cargo.toml @@ -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