aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Harrison <paul@harrison.sh>2022-12-15 16:43:09 +0000
committerPaul Harrison <paul@harrison.sh>2023-05-16 10:22:26 +0100
commit6f3de3a8853243d302132083edefe3f87f60dc07 (patch)
tree7da56f0d93f7274fa1e7edefe5b7e98e79f9a442 /README.md
parentaaea9c8aa3c7124599987ee14f88d51bcdadbcc2 (diff)
feat: Dockerize API
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4eef272..cec2780 100644
--- a/README.md
+++ b/README.md
@@ -97,7 +97,7 @@ Result: "straight flush: 10-high diamonds"
## Usage
- Install with `make install`.
- Run linting and tests with `make quality test coverage clean`.
-- Run API with `make API`.
+- Build the API container with `make build`, then run API with `docker compose up -d`.
- Check API health with `curl localhost:8000`
- Query API for rank with e.g.
```shell