update README.md

Author: vvatanabe

README.md

@@ -1 +1,36 @@
-# go-grpc-basics
+# WEB+DB PRESS Vol.110 特集2「［速習］gRPC」サンプルコード
+
+技術評論社刊「[WEB+DB PRESS Vol.110](https://gihyo.jp/magazine/wdpress/archive/2019/vol110)」の特集2「［速習］gRPC」のサンプルコードです。
+
+## 目次
+
+実行方法は各READMEをご覧ください。
+
+- [単項RPC ── 1リクエスト／1レスポンス](https://github.com/vvatanabe/go-grpc-basics/tree/master/echo)
+- [サーバサイドストリーミングRPC ── 1リクエスト／多レスポンス](https://github.com/vvatanabe/go-grpc-basics/tree/master/downloader)
+- [クライアントサイドストリーミングRPC ── 多リクエスト／1レスポンス](https://github.com/vvatanabe/go-grpc-basics/tree/master/uploader)
+- [双方向ストリーミングRPC ── 多リクエスト／多レスポンス](https://github.com/vvatanabe/go-grpc-basics/tree/master/chat)
+- [gRPCのインタセプタ](https://github.com/vvatanabe/go-grpc-basics/tree/master/interceptor)
+
+## 動作環境
+
+サンプルコードは次の環境で動作確認済みです。
+
+- Go 1.12
+- grpc-go 1.19.1
+- protobuf 3.7.0
+- protoc-gen-go 1.3.1
+
+## ライセンス
+
+サンプルコードはMITライセンスで配布しています。
+
+http://opensource.org/licenses/mit-license.php
+
+## お問い合わせ
+
+不具合があった場合は[本書Webページ](https://gihyo.jp/magazine/wdpress/archive/2019/vol110)よりお問い合わせをお願いいたします。
+
+## ご注意
+
+本サンプルコード、特集の内容に基づく運用結果について、著者、ソフトウェアの開発元および提供元、株式会社技術評論社は一切の責任を負いかねますので、あらかじめご了承ください。

chat/README.md

@@ -1,12 +1,23 @@
-# simple chat using bidirectional streaming RPC
+# 双方向ストリーミングRPC ── 多リクエスト／多レスポンス
+
+双方向ストリーミングRPCを使用した、簡易的なチャット機能の例です。
+
+## .protoファイルをコンパイルする
 
 ```
-# build .proto
 $ protoc -I ./chat/proto --go_out=plugins=grpc:./chat/proto/ ./chat/proto/chat.proto
+```
 
-# run server
+## gRPCサーバを起動する
+
+```
 $ go run ./chat/server
+```
+
+## gRPCクライアントプログラムを実行する
 
-# run client
+引数に適当なユーザ名を与えて実行します。
+
+```
 $ go run ./chat/client $USER_NAME
 ```

downloader/README.md

@@ -1,12 +1,23 @@
-# file downloader using server-side streaming RPC
+# サーバサイドストリーミングRPC ── 1リクエスト／多レスポンス
+
+サーバサイドストリーミングRPCを使用した、ファイルのダウンロード機能の例です。
+
+## .protoファイルをコンパイルする
 
 ```
-# build .proto
 $ protoc -I ./downloader/proto --go_out=plugins=grpc:./downloader/proto/ ./downloader/proto/file.proto
+```
 
-# run server
+## gRPCサーバを起動する
+
+```
 $ go run ./downloader/server
+```
+
+## gRPCクライアントプログラムを実行する
+
+引数にダウンロードするファイル名を与えて実行します。
 
-# run client
-$ go run ./downloader/client $FILE_NAME
 ```
+$ go run ./downloader/client $FILE_NAME
+```

echo/README.md

@@ -1,12 +1,23 @@
-# echo server using unary RPC
+# 単項RPC ── 1リクエスト／1レスポンス
+
+単項RPCを使用した、クライアントからの入力をそのまま返却するEchoサーバの例です。
+
+## .protoファイルをコンパイルする
 
 ```
-# build .proto
 $ protoc -I ./echo/proto --go_out=plugins=grpc:./echo/proto/ ./echo/proto/echo.proto
+```
 
-# run server
+## gRPCサーバを起動する
+
+```
 $ go run ./echo/server
+```
+
+## gRPCクライアントプログラムを実行する
+
+引数に適当な文言を与えて実行します。
 
-# run client
-$ go run ./echo/client hello
 ```
+$ go run ./echo/client hello
+```

interceptor/README.md

@@ -1,12 +1,23 @@
-# echo server using interceptor
+# gRPCのインタセプタ
+
+インタセプタを使用した例です。
+
+## .protoファイルをコンパイルする
 
 ```
-# build .proto
 $ protoc -I ./interceptor/proto --go_out=plugins=grpc:./interceptor/proto/ ./interceptor/proto/echo.proto
+```
 
-# run server
+## gRPCサーバを起動する
+
+```
 $ go run ./interceptor/server
+```
+
+## gRPCクライアントプログラムを実行する
+
+引数に適当な文言を与えて実行します。
 
-# run client
-$ go run ./interceptor/client hello
 ```
+$ go run ./interceptor/client hello
+```

uploader/README.md

@@ -1,12 +1,23 @@
-# file uploader using client-side streaming RPC
+# クライアントサイドストリーミングRPC ── 多リクエスト／1レスポンス
+
+クライアントサイドストリーミングRPCを使用した、ファイルのアップロード機能の例です。
+
+## .protoファイルをコンパイルする
 
 ```
-# build .proto
 $ protoc -I ./uploader/proto --go_out=plugins=grpc:./uploader/proto/ ./uploader/proto/file.proto
+```
 
-# run server
+## gRPCサーバを起動する
+
+```
 $ go run ./uploader/server
+```
+
+## gRPCクライアントプログラムを実行する
+
+引数にアップロードするファイル名を与えて実行します。
 
-# run client
-$ go run ./uploader/client $FILE_NAME
 ```
+$ go run ./uploader/client $FILE_NAME
+```