From 49f669df66fff3098bea2b546a681d8ed150901a Mon Sep 17 00:00:00 2001 From: Asim Aslam Date: Mon, 3 Jun 2019 19:16:43 +0100 Subject: [PATCH] update grpc readme --- service/grpc/README.md | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/service/grpc/README.md b/service/grpc/README.md index 70e750b0..ee333454 100644 --- a/service/grpc/README.md +++ b/service/grpc/README.md @@ -1,12 +1,12 @@ -# Micro gRPC [![License](https://img.shields.io/:license-apache-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![GoDoc](https://godoc.org/github.com/micro/go-micro/service/grpc?status.svg)](https://godoc.org/github.com/micro/go-micro/service/grpc) [![Travis CI](https://api.travis-ci.org/micro/go-micro/service/grpc.svg?branch=master)](https://travis-ci.org/micro/go-micro/service/grpc) [![Go Report Card](https://goreportcard.com/badge/micro/go-micro/service/grpc)](https://goreportcard.com/report/github.com/micro/go-micro/service/grpc) +# gRPC Service -A micro gRPC framework. A simplified experience for building gRPC services. +A simplified experience for building gRPC services. ## Overview -**Go gRPC** makes use of [go-micro](https://github.com/micro/go-micro) plugins to create a simpler framework for gRPC development. +The **gRPC service** makes use of [go-micro](https://github.com/micro/go-micro) plugins to create a simpler framework for gRPC development. It interoperates with standard gRPC services seamlessly, including the [grpc-gateway](https://github.com/grpc-ecosystem/grpc-gateway). -The go-grpc library uses the go-micro broker, client and server plugins which make use of +The grpc service uses the go-micro broker, client and server plugins which make use of [github.com/grpc/grpc-go](https://github.com/grpc/grpc-go) internally. This means we ignore the go-micro codec and transport but provide a native grpc experience. @@ -17,20 +17,12 @@ This means we ignore the go-micro codec and transport but provide a native grpc - **Service Discovery** - We make use of go-micro's registry and selector interfaces to provide pluggable discovery and client side load balancing. There's no need to dial connections, we'll do everything beneath the covers for you. -- **PubSub Messaging** - Where gRPC only provides you synchronous communication, **Go gRPC** uses the go-micro broker +- **PubSub Messaging** - Where gRPC only provides you synchronous communication, the **gRPC service** uses the go-micro broker to provide asynchronous messaging while using the gRPC protocol. - **Micro Ecosystem** - Make use of the existing micro ecosystem of tooling including our api gateway, web dashboard, command line interface and much more. We're enhancing gRPC with a simplified experience using micro. -## Examples - -Find an example greeter service in [examples/greeter](https://github.com/micro/go-micro/service/grpc/tree/master/examples/greeter). - -## Getting Started - -See the [docs](https://micro.mu/docs/go-grpc.html) to get started. - ## I18n ### [中文](README_cn.md)