Skip to content

Commit 5e699df

Browse files
authored
doc changes and updates related to proto-gen and examples (#210)
* fix: update documentation and proto script Signed-off-by: mikeee <[email protected]> * docs: add missing closure Signed-off-by: mikeee <[email protected]> * chore: exclude proto-gen and examples Signed-off-by: mikeee <[email protected]> --------- Signed-off-by: mikeee <[email protected]>
1 parent 6301ee4 commit 5e699df

File tree

3 files changed

+12
-3
lines changed

3 files changed

+12
-3
lines changed

Cargo.toml

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
members = [
33
"dapr",
44
"dapr-macros",
5-
"examples",
5+
]
6+
exclude = [
67
"proto-gen",
8+
"examples",
79
]
810
resolver = "2"

README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
6868

6969
// Create the client
7070
let mut client = dapr::Client::<dapr::client::TonicClient>::connect(addr).await?;
71+
}
7172
```
7273

7374
## Explore more examples
@@ -84,7 +85,7 @@ cargo build
8485

8586
>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.
8687
87-
## Updating .proto files from upstream Dapr
88+
## Developing (Updating .proto files from upstream Dapr)
8889

8990
To fetch the latest .proto files from Dapr execute the script `update-protos.sh`:
9091

@@ -98,6 +99,12 @@ By default, the script fetches the latest proto updates from the master branch o
9899
./update-protos.sh -v v1.14.0
99100
```
100101

102+
Protos can then be compiled using:
103+
104+
```bash
105+
cargo run proto-gen
106+
```
107+
101108
### Contact Us
102109
Reach out with any questions you may have and we'll be sure to answer them as
103110
soon as possible!

update-protos.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ RUNTIME="runtime"
2121
RUNTIME_RELEASE_TAG="master"
2222

2323
# Path to store output
24-
PROTO_PATH="dapr/proto"
24+
PROTO_PATH="proto/dapr/proto"
2525

2626
# Http request CLI
2727
HTTP_REQUEST_CLI=curl

0 commit comments

Comments
 (0)