From 9baafc80ed889c232587cf5d4cfaa2db44d1825a Mon Sep 17 00:00:00 2001
From: Paul Harrison <paul@harrison.sh>
Date: Sun, 20 Nov 2022 15:13:16 +0000
Subject: feat: Hand ranking API

Hand ranking API with a health check root endpoint and rank endpoint.
---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 4b8d985..d6cc434 100644
--- a/README.md
+++ b/README.md
@@ -88,3 +88,18 @@ Result: "full house: 4 over 2"
 Query: "6H 7H 8H 9H 10H"
 Result: "straight flush: 10-high diamonds"
 ```
+
+## Requirements
+- Python 3.11
+- [Poetry](https://python-poetry.org/)
+- [GNU Make](https://www.gnu.org/software/make/)
+
+## Usage
+- Install with `make install`.
+- Run linting and tests with `make quality test coverage clean`.
+- Run API with `make API`.
+- Check API health with `curl localhost:8000`
+- Query API for rank with e.g.
+  ```shell
+  curl -X POST -d '2H 3D 5S 10C KD' localhost:8000/rank
+  ```
-- 
cgit v1.2.3