README.md in lifegame-0.1.0 vs README.md in lifegame-0.1.1

- old
+ new

@@ -1,11 +1,54 @@ # Lifegame +Ruby CLI implementation of [Conway's Game of Life](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life). + +demo: `git clone` and `bundle install` and `bundle exec ./bin/demo` + [![demo](./demo.gif)](./demo.gif) +## Installation + +Add this line to your application's Gemfile: + +```ruby +gem 'lifegame' +``` +And then execute: + +``` +$ bundle install +``` + +Or install it yourself as: + +``` +$ gem install lifegame +``` + ## Usage -`git clone` and `bundle install` and `bundle exec ./bin/demo` +```ruby +# 20 x 50 +game = Lifegame::Lifegame.new(20, 50) + +# eg: grader +game[2,7].be!; game[2,8].be!; game[2,9].be!; game[1,7].be!; game[0,8].be! + +# print +puts game + +# next +game.next! +puts game + +# autoplay +game.start + +# random with alive frequency +game.sow!(0.2) +game.start +``` ## License The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).