Travis Readme Changelog License

Author: simple-hacker

.travis.yml

@@ -0,0 +1,14 @@
+language: php
+
+php:
+  - 7.0
+  - 7.1
+  - 7.2
+  - 7.3
+  - 7.4
+
+before_script:
+  - travis_retry composer update
+
+script:
+  - vendor/bin/phpunit

CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2020-11-25
+### Added
+- Initial release
+- Texas Holdem Hand

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Michael Perks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -11,7 +11,7 @@ composer require simple-hacker/PHPoker
 ## Usage
 
 ```php
-use simple-hacker\PHPoker\Hands\TexasHoldemHand
+use simplehacker\PHPoker\Hands\TexasHoldemHand;
 
 $communityCards = '3hJdQdAdKd';
 $holeCards = 'Td6s';
@@ -29,9 +29,65 @@ $communityCards = ['3h', 'Jd', 'Qd', 'Ad', 'Kd'];
 $communityCards = [new Card('3h'), new Card('Jd'), new Card('Qd'), new Card('Ad'), new Card('Kd')];
 $communityCards = [new Card('3h'), 'Jd', new Card('Qd'), 'Ad', new Card('Kd')];  // A mix of both
 ```
+
+Once a hand has been instantiated, you are able to get the hand description as well as a numerical value of the hand used for comparing against other hands.
+
+```php
+use simplehacker\PHPoker\Hands\TexasHoldemHand;
+
+$communityCards = '3hJdQdAdKd';
+$holeCards = 'Td6s';
+
+$hand = new TexasHoldemHand($communityCards, $holeCards);
+
+// Royal Flush, Ace to Ten of Diamonds
+$hand->getDescription();
+
+// AdKdQdJdTd
+$hand->getShortDescription();
+
+// 10
+$hand->getHandRank();
+
+// const ROYAL_FLUSH_RANK      = 10;
+// const STRAIGHT_FLUSH_RANK   = 9;
+// const FOUR_OF_A_KIND_RANK   = 8;
+// const FULL_HOUSE_RANK       = 7;
+// const FLUSH_RANK            = 6;
+// const STRAIGHT_RANK         = 5;
+// const THREE_OF_A_KIND_RANK  = 4;
+// const TWO_PAIR_RANK         = 3;
+// const ONE_PAIR_RANK         = 2;
+// const HIGH_CARD_RANK        = 1;
+
+// 11459770
+$hand->getHandValue();
+
+// Hand value is generated from converting Hand Rank and all Card values to a binary string, and converting back to base 10.  This ensures the best hand will always be the highest number
+```
+
+
 ## Cards
+Cards can be instantiated in numerous ways.  The follwing all result in the Ace of Spades:
+
+```php
+// As a short value where the first character is 23456789TJQKA and the suit as shcd
+new Card('As');
 
+// Arguments for both value and suit
+new Card('Ace', 'Spades');
+new Card('A', 's');
 
+// As numerical values
+// Jack = 11, Queen = 12, King = 13, Ace = 1 or 14
+// Clubs = 1, Diamonds = 2, Hearts = 3, Spades = 4
+new Card(14, 4);
+
+// Or any combination of the above
+new Card('Ace', 's');
+new Card(1, 'spades');
+```
+A InvalidCardException will be thrown for invalid values or suits
 
 ## Upcoming releases
 - Compare TexasHoldemHands to determine winner