diff --git a/docs/getting_started.md b/docs/getting_started.md index 6374de9a..e486a4ae 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -50,7 +50,7 @@ And MkUnion use it heavily to offer way of adding new behaviour to go types. ##### Tags supported by MkUnion - `go:tag mkunion:"Vehicle"` - define union type -- `go:tag serde:"json"` - enable serialisation type (currently only JSON is supported), enbabled by default +- `go:tag serde:"json"` - enable serialisation type (currently only JSON is supported), enabled by default - `go:tag shape:"-"` - disable shape generation for this type, useful in cases x/shared package cannot depend on other x packages, to avid circular dependencies - `go:tag mkunion:",no-type-registry"` - if you want to disable generation type registry in a package, in one of go files above package declaration define tag ```go @@ -158,4 +158,4 @@ func ExampleVehicleToJSON() { You can notice that it has opinionated way of marshalling and unmarshalling your union type. It uses `$type` field to store type information, and then store actual data in separate field, with corresponding name. -You can read more about it in [Marshaling union in JSON](./examples/json.md) section. \ No newline at end of file +You can read more about it in [Marshaling union in JSON](./examples/json.md) section.