README.md in avromatic-0.22.0 vs README.md in avromatic-0.23.0
- old
+ new
@@ -116,10 +116,18 @@
include Avromatic::Model.build(schema: schema_object)
end
```
Models are generated as [Virtus](https://github.com/solnic/virtus) value
-objects. `Virtus` attributes are added for each field in the Avro schema
+objects by default, but can optionally be defined as mutable:
+
+```ruby
+class MyModel
+ include Avromatic::Model.build(schema_name :my_model, mutable: true)
+end
+```
+
+`Virtus` attributes are added for each field in the Avro schema
including any default values defined in the schema. `ActiveModel` validations
are used to define validations on certain types of fields ([see below](#validations)).
A model may be defined with both a key and a value schema: