From e3ca0677607e09e67443e8b95597c6767ff62b91 Mon Sep 17 00:00:00 2001 From: Phillip Oliver <35277050+PhillOliver-Dev@users.noreply.github.com> Date: Mon, 8 Jul 2019 18:44:58 +0100 Subject: [PATCH 1/2] gRPC update to README.md Add helper functions to prevent users facing the issue of not being able to utilise all generators. --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7d5698f..90e34ab 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,12 @@ This is what `GoKit Cli` is aiming to change. GoKit Cli needs to be installed using `go get` and `go install` so `Go` is a requirement to be able to test your services [gokit](https://github.com/go-kit/kit) is needed. +To utilise generation of gRPC service code through `kit generate service -t grpc` you will need to install the grpc prequisites. +``` +go get -u google.golang.org/grpc +go get -u github.com/golang/protobuf/protoc-gen-go +``` + # Table of Content - [Installation](#installation) - [Usage](#usage) @@ -122,4 +128,4 @@ docker-compose up ``` After you run `docker-compose up` your services will start up and any change you make to your code will automatically - rebuild and restart your service (only the service that is changed) \ No newline at end of file + rebuild and restart your service (only the service that is changed) From 4cc204c00d77b2a7dab16feffcc418e2cc5d0857 Mon Sep 17 00:00:00 2001 From: Phillip Oliver <35277050+PhillOliver-Dev@users.noreply.github.com> Date: Mon, 8 Jul 2019 18:47:16 +0100 Subject: [PATCH 2/2] Add URL to docs to install grpc to README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 90e34ab..63ccf41 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ This is what `GoKit Cli` is aiming to change. GoKit Cli needs to be installed using `go get` and `go install` so `Go` is a requirement to be able to test your services [gokit](https://github.com/go-kit/kit) is needed. -To utilise generation of gRPC service code through `kit generate service -t grpc` you will need to install the grpc prequisites. +To utilise generation of gRPC service code through `kit generate service -t grpc` you will need to install the [grpc prequisites](https://grpc.io/docs/quickstart/go/). ``` go get -u google.golang.org/grpc go get -u github.com/golang/protobuf/protoc-gen-go