diff options
| author | Paul Harrison <paul@harrison.sh> | 2022-12-15 16:40:52 +0000 |
|---|---|---|
| committer | Paul Harrison <paul@harrison.sh> | 2023-05-16 10:22:19 +0100 |
| commit | aaea9c8aa3c7124599987ee14f88d51bcdadbcc2 (patch) | |
| tree | 23aed13e04cd882427b8a8a2444f5d1b7dee3431 | |
| parent | 9baafc80ed889c232587cf5d4cfaa2db44d1825a (diff) | |
docs: Update README with requirements
| -rw-r--r-- | README.md | 4 |
1 files changed, 2 insertions, 2 deletions
@@ -1,6 +1,6 @@ # Single Poker Hand Ranking Service -## Requirements -This service comprises an API to compute the rank of an individual poker hand. The requirements are to: +## Project Scope +This service comprises an API to compute the rank of an individual poker hand. The scope of this project is to: - Write an algorithm that takes a hand of cards and identifies the ranking of the given hand. - Expose an API to serve this algorithm via an endpoint `/rank`, that accepts a valid poker hand and returns its ranking. |