update readme
This commit is contained in:
		
							
								
								
									
										25
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										25
									
								
								README.md
									
									
									
									
									
								
							| @@ -35,12 +35,23 @@ Watch the [Golang UK Conf 2016](https://www.youtube.com/watch?v=xspaDovwk34) vid | |||||||
|  |  | ||||||
| ## Getting started | ## Getting started | ||||||
|  |  | ||||||
|  | - [Install Protobuf](#install-protobuf) | ||||||
| - [Service Discovery](#service-discovery) | - [Service Discovery](#service-discovery) | ||||||
| - [Writing a Service](#writing-a-service) | - [Writing a Service](#writing-a-service) | ||||||
| - [Writing a Function](#writing-a-function) | - [Writing a Function](#writing-a-function) | ||||||
| - [Plugins](#plugins) | - [Plugins](#plugins) | ||||||
| - [Wrappers](#wrappers) | - [Wrappers](#wrappers) | ||||||
|  |  | ||||||
|  | ## Install Protobuf | ||||||
|  |  | ||||||
|  | Protobuf is required for code generation | ||||||
|  |  | ||||||
|  | You'll need to install: | ||||||
|  |  | ||||||
|  | - [protoc](https://github.com/google/protobuf) | ||||||
|  | - [protoc-gen-go](https://github.com/golang/protobuf) | ||||||
|  | - [protoc-gen-micro](https://github.com/micro/protoc-gen-micro) | ||||||
|  |  | ||||||
| ## Service Discovery | ## Service Discovery | ||||||
|  |  | ||||||
| Service discovery is used to resolve service names to addresses. It's the only dependency of go-micro. | Service discovery is used to resolve service names to addresses. It's the only dependency of go-micro. | ||||||
| @@ -91,23 +102,12 @@ message HelloResponse { | |||||||
| } | } | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ### Install protobuf |  | ||||||
|  |  | ||||||
| Install [protobuf](https://developers.google.com/protocol-buffers/) |  | ||||||
|  |  | ||||||
| Now install the micro fork of protoc-gen-go. The protobuf compiler for Go.  |  | ||||||
|  |  | ||||||
| ```shell |  | ||||||
| go get github.com/micro/protobuf/{proto,protoc-gen-go} |  | ||||||
| ``` |  | ||||||
|  |  | ||||||
| ### Generate the proto | ### Generate the proto | ||||||
|  |  | ||||||
| After writing the proto definition we must compile it using protoc with the micro plugin. | After writing the proto definition we must compile it using protoc with the micro plugin. | ||||||
|  |  | ||||||
| ```shell | ```shell | ||||||
| protoc -I$GOPATH/src --go_out=plugins=micro:$GOPATH/src \ | protoc --proto_path=$GOPATH/src:. --micro_out=. --go_out=. path/to/greeter.proto | ||||||
| 	$GOPATH/src/github.com/micro/examples/service/proto/greeter.proto |  | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ### Write the service | ### Write the service | ||||||
| @@ -191,6 +191,7 @@ import ( | |||||||
| func main() { | func main() { | ||||||
| 	// Create a new service. Optionally include some options here. | 	// Create a new service. Optionally include some options here. | ||||||
| 	service := micro.NewService(micro.Name("greeter.client")) | 	service := micro.NewService(micro.Name("greeter.client")) | ||||||
|  | 	service.Init() | ||||||
|  |  | ||||||
| 	// Create new greeter client | 	// Create new greeter client | ||||||
| 	greeter := proto.NewGreeterClient("greeter", service.Client()) | 	greeter := proto.NewGreeterClient("greeter", service.Client()) | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user