From 06bdb9e9b7d1d3771b1ad136a5dc2dfe80613c7a Mon Sep 17 00:00:00 2001 From: Alexander Zeitler Date: Sat, 28 Sep 2024 06:26:20 +0200 Subject: [PATCH] docs: remove import statements --- docs/getting-started.md | 18 ++---------------- 1 file changed, 2 insertions(+), 16 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 8eaf560f..0dd634dc 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -10,9 +10,9 @@ npm install --save-dev docker-compose ``` -### Import for `docker-compose` (v1) +### Import for `docker-compose` -To import commands for the v1 version, please use this import statement: +To import commands, please use this import statement: ```ts import * as compose from 'docker-compose' @@ -24,20 +24,6 @@ You can also import only the required commands: import { run, upAll } from 'docker-compose' ``` -### Import for `docker compose` (v2) - -To import commands for the v2 version, please use this import statement: - -```ts -import { v2 as compose } from 'docker-compose' -``` - -You can also import only the required commands: - -```ts -import { run, upAll } from 'docker-compose/dist/v2' -``` - ### Known issues with v2 support * During testing we noticed that `docker compose` seems to send it's exit code also commands don't seem to have finished. This doesn't occur for all commands, but for example with `stop` or `down`. We had the option to wait for stopped / removed containers using third party libraries but this would make bootstrapping `docker-compose` much more complicated for the users. So we decided to use a `setTimeout(500)` workaround. We're aware this is not perfect but it seems to be the most appropriate solution for now. Details can be found in the [v2 PR discussion](https://github.com/PDMLab/docker-compose/pull/228#issuecomment-1422895821) (we're happy to get help here).