Skip to content

Commit

Permalink
Remove wkt option from README
Browse files Browse the repository at this point in the history
  • Loading branch information
nockty committed Dec 6, 2023
1 parent 7e34ec7 commit 42f444a
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,11 +113,9 @@ The following features can be generated:

7. (Optional) Switch your RPC framework to use the optimized helpers (see following sections)

## Well-known types
## `vtprotobuf` package and well-known types

By default, `vtprotobuf` will detect ProtoBuf [well-known types](https://protobuf.dev/reference/protobuf/google.protobuf/) embedded in your own Messages and generate optimized code to marshal and unmarshal them.

In order to access the optimized code for these types, your `_vtproto.pb.go` files will have a dependency on this Go package. If this is not acceptable, you can disable well-known types with `--go-vtproto_opt=wkt=false`.
Your generated `_vtproto.pb.go` files will have a dependency on this Go package to access some helper functions as well as the optimized code for ProtoBuf [well-known types](https://protobuf.dev/reference/protobuf/google.protobuf/). `vtprotobuf` will detect these types embedded in your own Messages and generate optimized code to marshal and unmarshal them.

## Using the optimized code with RPC frameworks

Expand Down

0 comments on commit 42f444a

Please sign in to comment.