diff --git a/README.md b/README.md index d53862c..4a1f450 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,11 @@ message Foo { string bar = 1; string zonk = 2; } + +message ExcludeThis { + string bar = 1; + string zonk = 2; +} ``` and creates this go code @@ -57,15 +62,7 @@ func (x *Foo) Scan(value interface{}) error { } ``` -## Configuration - -| Option | Meaning | Default | -| ------------------ | -------------------------------------------------------------------------------------- | ------- | -| `use_proto_names` | UseProtoNames uses proto field name instead of lowerCamelCase name in JSON field names | `true` | -| `emit_unpopulated` | EmitUnpopulated specifies whether to emit unpopulated fields | `true` | -| `exclude` | Takes a message identifier. Can be multiple identifier delimited by `,` | none | - -### Example +with this `buf.gen.yaml` ```yaml version: v1 @@ -79,3 +76,11 @@ plugins: opt: - paths=source_relative,use_proto_names=false,emit_unpopulated=true,exclude=git.wobcom.de/smartmetering/protoc-gen-go-value-scan/test/go/foo/v1.ExcludeThis ``` + +## Configuration + +| Option | Meaning | Default | +| ------------------ | -------------------------------------------------------------------------------------- | ------- | +| `use_proto_names` | UseProtoNames uses proto field name instead of lowerCamelCase name in JSON field names | `true` | +| `emit_unpopulated` | EmitUnpopulated specifies whether to emit unpopulated fields | `true` | +| `exclude` | Takes a message identifier. Can be multiple identifier delimited by `,` | none |