Create README.md

Author: tscpp

README.md

@@ -0,0 +1,49 @@
+# Protoc Tools gRPC Web Plugin
+**Protoc gRPC web generator plugin for @accility/protoc-tools ([NPM](https://npmjs.com/package/accility/protoc-tools) | [GitHub](https://github.com/accility/protoc-tools))**
+
+This package downloads and utilizes the [gRPC Web](https://github.com/grpc/grpc-web) ([protoc-gen-grpc-web](https://github.com/grpc/grpc-web/releases)) plugin from the [gRPC](https://github.com/grpc) project on post-install.
+
+[protoc-gen-grpc-web](https://github.com/grpc/grpc-web/releases) is a plugin and can be used with [@accility/protoc-tools](https://github.com/accility/protoc-tools) directly. But protoc-gen-grpc-web is a binary and needs to be installed for respectively operating system, which this plugin does on post-install **and** needs to be executed in PATH, which this plugin adds the binary directory to the process enviroment PATH variable.
+
+## Usage
+
+```javascript
+import * as tools from '@accility/protoc-tools'
+import * as gRPCWeb from '../dist/plugin'
+
+// OR
+
+const tools = require('@accility/protoc-tools')
+const gRPCWeb = require('../dist/plugin')
+
+tools.protoc({
+	...
+	outOptions: [
+		gRPCWeb({
+			module: 'commonjs', // 'closure' | 'commonjs' | 'commonjs+dts' | 'typescript'
+			// mode: 'grpcwebtext' | 'grpcweb'
+		})
+	]
+})
+```
+
+### Module
+Import style (https://github.com/grpc/grpc-web#import-style)
+
+- `closure` - the default generated code has Closure `goog.require()` import style.
+- `commonjs` - the CommonJS style `require()` is also supported.
+- `commonjs+dts` - (experimental) in addition to above, a .d.ts typings file will also be generated for the protobufssages and service stub.
+- `typescript` - (experimental) the service stub will be generat
+
+### Mode
+Wire format mode (https://github.com/grpc/grpc-web#wire-format-mode)
+
+`grpcwebtext`: The default generated code sends the payload in the grpc-web-text format.
+- `Content-type: application/grpc-web-text`
+- Payload are base64-encoded.
+- Both unary and server streaming calls are supported.
+
+`grpcweb`: A binary protobuf format is also supported.
+- `Content-type: application/grpc-web+proto`
+- Payload are in the binary protobuf format.
+- Only unary calls are supported for now.