grpc-rs icon indicating copy to clipboard operation
grpc-rs copied to clipboard

Add a basics tutorial to show how to use this crate

Open BusyJay opened this issue 8 years ago • 6 comments
trafficstars

Although there are examples and tests already, it would be better to have a tutorial just like https://grpc.io/docs/ lists.

BusyJay avatar Nov 16 '17 11:11 BusyJay

Yes, we should add it ASAP.

siddontang avatar Nov 16 '17 11:11 siddontang

Hi has there been any progress on this? My main issue is that it seems like the proto generated files assume a particular dir structure and therefore maybe a module like cargo build.

Not sure how to set up my project to use this.

toidiu avatar Jan 14 '18 20:01 toidiu

The structure it assumes is the same as rust-protobuf does. You need to add a mod.rs manually to include all the generated codes.

BusyJay avatar Jan 15 '18 05:01 BusyJay

In learning how to use the crate I created a small sample project reusing the components of this repo. https://github.com/toidiu/grcp-rs-example

I would appreciate any feedback you might have.

toidiu avatar Jan 15 '18 17:01 toidiu

Unless someone is already working on this issue, I'd like to run with it. I tend to prefer the mdBook style over other documentation methods like github wikis or just markdown files in the repo. Using mdbook would require some additional consideration for hosting/infrastructure though. I'd like to get some input from others before committing to a particular documentation format/system. Until then, I'll work on general guides and examples.

brahmlower avatar Jan 04 '19 05:01 brahmlower

No, IIRC there's nobody working on this currently. We'll appreciate your contribution.

ice1000 avatar Jan 04 '19 15:01 ice1000