diff --git a/README.md b/README.md index 56dcce28..f7ad1eea 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,12 @@ know more about crAPI, please check [crAPI's overview][overview]. ## QuickStart Guide -### Docker +### Docker and docker-compose -You'll need to have Docker installed and running on your host system. +You'll need to have Docker and docker-compose installed and running on your host system. Also, the version of docker-compose should be `1.27.0` or above. Check your docker-compose version using: +``` +docker-compose version +``` #### Using prebuilt images You can use prebuilt images generated by our CI workflow. diff --git a/docs/setup.md b/docs/setup.md index 9b9a5f84..626fd478 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -1,9 +1,12 @@ Setup | crAPI ============= -## Docker +## Docker and docker-compose -You'll need to have Docker installed and running on your host system. +You'll need to have Docker and docker-compose installed and running on your host system. Also, the version of docker-compose should be `1.27.0` or above. Check your docker-compose version using: +``` +docker-compose version +``` ### Using prebuilt images You can use prebuilt images generated by our CI workflow.