Merge pull request #112 from tokopedia/add_diagram_in_readme

Add diagram in readme

Readme.md

@@ -5,37 +5,40 @@ The server implementation is in GoLang but the client can be any programming lan
 
 ---
 
-### Announcement:
-The latest [version (v1.10)](https://github.com/tokopedia/gripmock/releases/tag/v1.10) of gripmock is requiring `go_package` declaration in the `.proto` file. This is due to the latest update of `protoc` plugin that being used by gripmock is making the `go_package` declaration mandatory.
-
-**Update Feb 2022:**
+## Quick Usage
+First, prepare your `.proto` file. Or you can use `hello.proto` in `example/simple/` folder. Suppose you put it in `/mypath/hello.proto`. We are gonna use Docker image for easier example test.
+basic syntax to run GripMock is
+`gripmock <protofile>`
 
-[Version 1.11-beta](https://github.com/tokopedia/gripmock/releases/tag/v1.11-beta) release is available.
-It supports **NO** declaration of `go_package`, please download and test before it can be tagged as stable.
+- Install [Docker](https://docs.docker.com/install/)
+- Run `docker pull tkpd/gripmock` to pull the image
+- We are gonna mount `/mypath/hello.proto` (it must be a fullpath) into a container and also we expose ports needed. Run `docker run -p 4770:4770 -p 4771:4771 -v /mypath:/proto tkpd/gripmock /proto/hello.proto`
+- On a separate terminal we are gonna add a stub into the stub service. Run `curl -X POST -d '{"service":"Gripmock","method":"SayHello","input":{"equals":{"name":"gripmock"}},"output":{"data":{"message":"Hello GripMock"}}}' localhost:4771/add `
+- Now we are ready to test it with our client. You can find a client example file under `example/simple/client/`. Execute one of your preferred language. Example for go: `go run example/simple/client/go/*.go`
 
-you can get the docker image using `docker pull tkpd/gripmock:v1.11-beta`.
+Check [`example`](https://github.com/tokopedia/gripmock/tree/master/example) folder for various usecase of gripmock.
 
 ---
 
 ## How It Works
-GripMock has 2 main components:
+![Running Gripmock](/assets/images/gripmock_readme-running%20system.png)
+
+From client perspective, GripMock has 2 main components:
 1. GRPC server that serves on `tcp://localhost:4770`. Its main job is to serve incoming rpc call from client and then parse the input so that it can be posted to Stub service to find the perfect stub match.
 2. Stub server that serves on `http://localhost:4771`. Its main job is to store all the stub mapping. We can add a new stub or list existing stub using http request.
 
 Matched stub will be returned to GRPC service then further parse it to response the rpc call.
 
-## Quick Usage
-First, prepare your `.proto` file. Or you can use `hello.proto` in `example/simple/` folder. Suppose you put it in `/mypath/hello.proto`. We are gonna use Docker image for easier example test.
-basic syntax to run GripMock is
-`gripmock <protofile>`
 
-- Install [Docker](https://docs.docker.com/install/)
-- Run `docker pull tkpd/gripmock` to pull the image
-- We are gonna mount `/mypath/hello.proto` (it must be a fullpath) into a container and also we expose ports needed. Run `docker run -p 4770:4770 -p 4771:4771 -v /mypath:/proto tkpd/gripmock /proto/hello.proto`
-- On a separate terminal we are gonna add a stub into the stub service. Run `curl -X POST -d '{"service":"Gripmock","method":"SayHello","input":{"equals":{"name":"gripmock"}},"output":{"data":{"message":"Hello GripMock"}}}' localhost:4771/add `
-- Now we are ready to test it with our client. You can find a client example file under `example/simple/client/`. Execute one of your preferred language. Example for go: `go run example/simple/client/go/*.go`
+From technical perspective, GripMock consists of 2 binaries. 
+The first binary is the gripmock itself, when it will generate the gRPC server using the plugin installed in the system (see [Dockerfile](Dockerfile)). 
+When the server sucessfully generated, it will be invoked in parallel with stub server which ends up opening 2 ports for client to use.
 
-Check [`example`](https://github.com/tokopedia/gripmock/tree/master/example) folder for various usecase of gripmock.
+The second binary is the protoc plugin which located in folder [protoc-gen-gripmock](/protoc-gen-gripmock). This plugin is the one who translates protobuf declaration into a gRPC server in Go programming language. 
+
+![Inside GripMock](/assets/images/gripmock_readme-inside.png)
+
+---
 
 ## Stubbing