Index: third_party/grpc/src/ruby/pb/README.md |
diff --git a/third_party/grpc/src/ruby/pb/README.md b/third_party/grpc/src/ruby/pb/README.md |
new file mode 100644 |
index 0000000000000000000000000000000000000000..d9e30bbc854434947bb9560d4115d448170ef64a |
--- /dev/null |
+++ b/third_party/grpc/src/ruby/pb/README.md |
@@ -0,0 +1,42 @@ |
+Protocol Buffers |
+================ |
+ |
+This folder contains protocol buffers provided with gRPC ruby, and the generated |
+code to them. |
+ |
+PREREQUISITES |
+------------- |
+ |
+The code is is generated using the protoc (> 3.0.0.alpha.1) and the |
+grpc_ruby_plugin. These must be installed to regenerate the IDL defined |
+classes, but that's not necessary just to use them. |
+ |
+health_check/v1 |
+-------------------- |
+ |
+This package defines the surface of a simple health check service that gRPC |
+servers may choose to implement, and provides an implementation for it. To |
+re-generate the surface. |
+ |
+```bash |
+$ # (from this directory) |
+$ protoc -I ../../proto ../../proto/grpc/health/v1/health.proto \ |
+ --grpc_out=. \ |
+ --ruby_out=. \ |
+ --plugin=protoc-gen-grpc=`which grpc_ruby_plugin` |
+``` |
+ |
+test |
+---- |
+ |
+This package defines the surface of the gRPC interop test service and client |
+To re-generate the surface, it's necessary to have checked-out versions of |
+the grpc interop test proto, e.g, by having the full gRPC repository. E.g, |
+ |
+```bash |
+$ # (from this directory within the grpc repo) |
+$ protoc -I../../.. ../../../test/proto/{messages,test,empty}.proto \ |
+ --grpc_out=. \ |
+ --ruby_out=. \ |
+ --plugin=protoc-gen-grpc=`which grpc_ruby_plugin` |
+``` |