Skip to content
This repository was archived by the owner on Nov 27, 2023. It is now read-only.

Commit 9370ca3

Browse files
authored
Merge pull request #1600 from gtardif/doc_readme
Update readme and clarify relation to docker-compose
2 parents a1aa6e3 + 0312556 commit 9370ca3

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,36 @@
33
[![Actions Status](https://github.com/docker/compose-cli/workflows/Continuous%20integration/badge.svg)](https://github.com/docker/compose-cli/actions)
44
[![Actions Status](https://github.com/docker/compose-cli/workflows/Windows%20CI/badge.svg)](https://github.com/docker/compose-cli/actions)
55

6-
This CLI tool makes it easy to run Docker containers and Docker Compose applications in the cloud using either Amazon
7-
Elastic Container Service
6+
This Compose CLI tool makes it easy to run Docker containers and Docker Compose applications:
7+
* locally as a command in the docker CLI, using `docker compose ...` comands.
8+
* in the cloud using either Amazon Elastic Container Service
89
([ECS](https://aws.amazon.com/ecs))
910
or Microsoft Azure Container Instances
1011
([ACI](https://azure.microsoft.com/services/container-instances))
1112
using the Docker commands you already know.
1213

13-
To get started, all you need is:
14+
## Local Docker Compose
15+
16+
The `docker compose` local command is meant to be the next major version for docker-compose, and it supports the same commands and flags, in order to be used as a drop-in replacement.
17+
[Here](https://github.com/docker/compose-cli/issues/1283) is a checklist of docker-compose commands and flags that are implemented in `docker compose`.
18+
19+
This `docker compose` local command :
20+
* has a better integration with the rest of the docker ecosystem (being written in go, it's easier to share functionality with the Docker CLI and other Docker libraries)
21+
* is quicker and uses more parallelism to run multiple tasks in parallel. It also uses buildkit by default
22+
* includes additional commands, like `docker compose ls` to list current compose projects
23+
24+
## Getting started
25+
26+
To get started with Compose CLI, all you need is:
1427

15-
* An [AWS](https://aws.amazon.com) or [Azure](https://azure.microsoft.com)
16-
account
1728
* Windows: The Stable or Edge release of
1829
[Docker Desktop](https://hub.docker.com/editions/community/docker-ce-desktop-windows)
1930
* macOS: The Stable or Edge release of
2031
[Docker Desktop](https://hub.docker.com/editions/community/docker-ce-desktop-mac)
2132
* Linux:
2233
[Install script](INSTALL.md)
34+
* An [AWS](https://aws.amazon.com) or [Azure](https://azure.microsoft.com)
35+
account in order to use the Compose Cloud integration
2336

2437
Please create [issues](https://github.com/docker/compose-cli/issues) to leave feedback.
2538

0 commit comments

Comments
 (0)