From aaea9c8aa3c7124599987ee14f88d51bcdadbcc2 Mon Sep 17 00:00:00 2001 From: Paul Harrison Date: Thu, 15 Dec 2022 16:40:52 +0000 Subject: [PATCH] docs: Update README with requirements --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d6cc434..4eef272 100644 --- a/README.md +++ b/README.md @@ -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.