vendor/google.golang.org/grpc/README.md

   1 # gRPC-Go
   2
   3 [![Build Status](https://travis-ci.org/grpc/grpc-go.svg)](https://travis-ci.org/grpc/grpc-go) [![GoDoc](https://godoc.org/google.golang.org/grpc?status.svg)](https://godoc.org/google.golang.org/grpc) [![GoReportCard](https://goreportcard.com/badge/grpc/grpc-go)](https://goreportcard.com/report/github.com/grpc/grpc-go)
   4
   5 The Go implementation of [gRPC](https://grpc.io/): A high performance, open source, general RPC framework that puts mobile and HTTP/2 first. For more information see the [gRPC Quick Start: Go](https://grpc.io/docs/quickstart/go.html) guide.
   6
   7 Installation
   8 ------------
   9
  10 To install this package, you need to install Go and setup your Go workspace on your computer. The simplest way to install the library is to run:
  11
  12 ```
  13 $ go get -u google.golang.org/grpc
  14 ```
  15
  16 Prerequisites
  17 -------------
  18
  19 This requires Go 1.6 or later.  Go 1.7 will be required as of the next gRPC-Go
  20 release (1.8).
  21
  22 Constraints
  23 -----------
  24 The grpc package should only depend on standard Go packages and a small number of exceptions. If your contribution introduces new dependencies which are NOT in the [list](http://godoc.org/google.golang.org/grpc?imports), you need a discussion with gRPC-Go authors and consultants.
  25
  26 Documentation
  27 -------------
  28 See [API documentation](https://godoc.org/google.golang.org/grpc) for package and API descriptions and find examples in the [examples directory](examples/).
  29
  30 Performance
  31 -----------
  32 See the current benchmarks for some of the languages supported in [this dashboard](https://performance-dot-grpc-testing.appspot.com/explore?dashboard=5652536396611584&widget=490377658&container=1286539696).
  33
  34 Status
  35 ------
  36 General Availability [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages).
  37
  38 FAQ
  39 ---
  40
  41 #### Compiling error, undefined: grpc.SupportPackageIsVersion
  42
  43 Please update proto package, gRPC package and rebuild the proto files:
  44  - `go get -u github.com/golang/protobuf/{proto,protoc-gen-go}`
  45  - `go get -u google.golang.org/grpc`
  46  - `protoc --go_out=plugins=grpc:. *.proto`