unistack-org/protoc-gen-go-micro
4
0
Fork 0
Code Issues 4 Pull Requests Actions Packages Projects Releases 65 Wiki Activity

update readme

Browse Source 
Signed-off-by: Vasiliy Tolstov <v.tolstov@unistack.org>
This commit is contained in:
Василий Толстов
2021-01-19 12:59:47 +03:00
parent 36030fa440
commit ba5b9e8eb8
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -55,12 +55,13 @@ $> protoc --gotemplate_out=debug=true,template_dir=/path/to/template/directory:.
| Option | Default Value | Accepted Values | Description | Option | Default Value | Accepted Values | Description
|-----------------------|---------------|---------------------------|----------------------- |-----------------------|---------------|---------------------------|-----------------------
| `template_repo` | `` | url in form schema://domain | path to repo with optional branch or revision after @ sign
| `template_dir`       | `./template` | absolute or relative path | path to look for templates | `template_dir`       | `./template` | absolute or relative path | path to look for templates
| `destination_dir`     | `.`           | absolute or relative path | base path to write output | `destination_dir`     | `.`           | absolute or relative path | base path to write output
| `single-package-mode` | *false* | `true` or `false` | if *true*, `protoc` won't accept multiple packages to be compiled at once (*!= from `all`*), but will support `Message` lookup across the imported protobuf dependencies | `single-package-mode` | *false* | `true` or `false` | if *true*, `protoc` won't accept multiple packages to be compiled at once (*!= from `all`*), but will support `Message` lookup across the imported protobuf dependencies
| `debug`               | *false*       | `true` or `false` | if *true*, `protoc` will generate a more verbose output | `debug`               | *false*       | `true` or `false` | if *true*, `protoc` will generate a more verbose output
| `all`                 | *false*       | `true` or `false`         | if *true*, protobuf files without `Service` will also be parsed | `all`                 | *false*       | `true` or `false`         | if *true*, protobuf files without `Service` will also be parsed
| `components` | `micro` | `micro, grpc, http, chi, gorilla | some values cant coexists like gorilla/chi or grpc/http
##### Hints ##### Hints
Shipping the templates with your project is very smart and useful when contributing on git-based projects. Shipping the templates with your project is very smart and useful when contributing on git-based projects.