Browse Source

New README for the Swift gRPC plugin.

Tim Burks 9 years ago
parent
commit
c092ceb154
1 changed files with 17 additions and 0 deletions
  1. 17 0
      Plugin/README.md

+ 17 - 0
Plugin/README.md

@@ -0,0 +1,17 @@
+# Swift gRPC Plugin
+
+This directory contains the Swift gRPC plugin for `protoc`,
+the Protocol Buffer Compiler.
+
+It is built with the Swift Package Manager and the included
+Makefile. The resulting binary is named `protoc-gen-swiftgrpc`
+and can be called from `protoc` by adding the `--swiftgrpc_out`
+command-line option. For example, here's an invocation from
+the Makefile:
+
+	protoc ../Examples/Echo/echo.proto --proto_path=../Examples/Echo --swiftgrpc_out=. 
+
+The plugin uses template files in the [templates](templates) 
+directory. This directory currently must be in the same location 
+where the compiler is run.
+