Readme.markdown in hands-0.0.2 vs Readme.markdown in hands-0.1.0

- old
+ new

@@ -2,10 +2,12 @@ Simple library for calculating poker hands. Currently this gem is very limited. I plan on adding outs, odds, and other actually useful stuff. I started writing this on a plane as a personal challenge. It's current state is crude, although tested and works. +[![Dependency Status](https://gemnasium.com/soffes/hands.png)](https://gemnasium.com/soffes/hands) + ## Installation Add this line to your application's Gemfile: ``` ruby @@ -20,10 +22,12 @@ $ gem install hands ## Usage +Read the [documentation](http://rubydoc.info/github/samsoffes/hands/master/frames). + ``` ruby # Best hand detection straight = Hands::Hand.new straight << Hands::Card['A', :hearts] straight << Hands::Card[2, :spades] @@ -47,27 +51,27 @@ flush << Hands::Card[2, :hearts] flush << Hands::Card[4, :hearts] flush > pair # true # Card comparison -card1 = Hands::Card.new(:value => 2, :suite => :hearts) -card2 = Hands::Card.new(:value => 3, :suite => :clubs) +card1 = Hands::Card.new(:value => 2, :suit => :hearts) +card2 = Hands::Card.new(:value => 3, :suit => :clubs) card2 > card1 # true ``` ## Running Tests Running and reading the tests is (for now) the best way to see the functionality of this gem. ``` -$ bundle -$ bundle exec rake spec +$ bundle exec rake ``` ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`) -3. Write a passing spec -4. Commit your changes (`git commit -am 'Added some feature'`) -5. Push to the branch (`git push origin my-new-feature`) -6. Create new Pull Request +3. Write passing specs +4. Write documentation +5. Commit your changes (`git commit -am 'Added some feature'`) +6. Push to the branch (`git push origin my-new-feature`) +7. Create new Pull Request