README.md in zeamays-0.0.1 vs README.md in zeamays-0.0.5
- old
+ new
@@ -1,7 +1,9 @@
# Zeamays
+[](https://travis-ci.org/myun2ext/zeamays)
+
Minimum Database gem for Ruby (notSQL)
## Installation
Add this line to your application's Gemfile:
@@ -16,10 +18,36 @@
$ gem install zeamays
## Usage
-TODO: Write usage instructions here
+Declare Modeling for
+
+```ruby
+class ExampleCobClass < Zeamays::Cob
+ gene_sequencing :i8, :i16, :integer, :string
+end
+```
+
+columns declare use for `gene_sequencing` **class method**.
+
+Symbol use for Column type.
+
+* `:i8`: 1byte Integer (8bits)
+* `:i16`: 2byte Integer (16bits)
+* `:i32` or `:integer`: 4byte Integer (32bits)
+* `:string`: String type (Any length usable)
+
+## Add new Record
+
+Use for `grow` or `grow!` method(`grow` method is alias for `grow!`).
+
+for example
+
+```ruby
+yellow_sweet = ExampleCobClass.new
+yellow_sweet.grow 30, 2000, 500000, "test"
+```
## Contributing
1. Fork it ( https://github.com/[my-github-username]/zeamays/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)