diff --git a/README.md b/README.md index 023a14c..d540a78 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,17 @@ An example for how to do this may look like this: ```bash docker run -v --env-file=.env ./.matchy:/usr/src/app/.matchy forge.mdiluz.io/mdiluz/matchy:latest ``` -A [`docker-compose.yml`](docker-compose.yml) file is also provided that essentially performs the above when used with `docker compose up --exit-code-from matchy`. A `MATCHY_DATA` envar can be used in conjunction with compose to set a custom local path for the location of the data file. + +### Docker compose +Matchy can easily be hosted with `docker compose` using a file like so: +```yaml +services: + matchy: + image: forge.mdiluz.io/mdiluz/matchy:${MATCHY_TAG:-latest} + env_file: ".env" + volumes: + - ${MATCHY_DATA:-./.matchy}:/usr/src/app/.matchy +``` ## TODO * Implement better tests to the discordy parts of the codebase