README.md in zeamays-0.0.5 vs README.md in zeamays-0.0.6
- old
+ new
@@ -21,11 +21,11 @@
## Usage
Declare Modeling for
```ruby
-class ExampleCobClass < Zeamays::Cob
+class YellowSweet < Zeamays::Cob
gene_sequencing :i8, :i16, :integer, :string
end
```
columns declare use for `gene_sequencing` **class method**.
@@ -42,12 +42,36 @@
Use for `grow` or `grow!` method(`grow` method is alias for `grow!`).
for example
```ruby
-yellow_sweet = ExampleCobClass.new
+yellow_sweet = YellowSweet.new
yellow_sweet.grow 30, 2000, 500000, "test"
```
+
+## Packing (Serialization)
+
+Use for `pack` method.
+
+```ruby
+yellow_sweet.pack
+```
+
+returned **serialized** String.
+
+## Unpacking (Deserialization)
+
+Use for `unpack` **class method**.
+
+```ruby
+YellowSweet.unpack(packed_string)
+```
+
+returned **deserialized** values.
+
+## Persistation for File System
+
+TODO
## Contributing
1. Fork it ( https://github.com/[my-github-username]/zeamays/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)