izumin5210 / grapi

😮 A surprisingly easy API server and generator in gRPC and Go
https://godoc.org/github.com/izumin5210/grapi/pkg/grapiserver
MIT License
427 stars 39 forks source link

"Getting started" documentation is incomplete #300

Open werdnum opened 3 years ago

werdnum commented 3 years ago

My apologies if there's some more complete documentation somewhere else that I can't find.

The documentation in README is not complete. That is: it doesn't tell you everything you need to do to get an example application running. In particular, I suspect that I'm supposed to create my gRPC proto service definition somewhere for grapi to process. But I don't see that documented anywhere.

What would be helpful would be a complete walkthrough with step by step instructions of how to produce an example application. Either that, or a bit more of an explanation of the operating principle so that I can at least derive my own instructions.