diff --git a/.github/workflows/main-ci.yml b/.github/workflows/main-ci.yml
index fd4ce51..8d39993 100644
--- a/.github/workflows/main-ci.yml
+++ b/.github/workflows/main-ci.yml
@@ -14,6 +14,7 @@ jobs:
secrets: inherit
generate-readme:
+ needs: ci
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
diff --git a/README.md b/README.md
index 68ed8f5..ff36b33 100644
--- a/README.md
+++ b/README.md
@@ -11,10 +11,7 @@
-
-



-
-
+
@@ -55,6 +52,9 @@ Run your docker-compose file
```
+
+## Inputs
+
| **Input** | **Description** | **Default** | **Required** |
@@ -68,5 +68,60 @@ Run your docker-compose file
+
+## Examples
+
+
+### Example Using environment variables
+
+```yaml
+steps:
+ - uses: actions/checkout@v4
+ - uses: hoverkraft-tech/compose-action@v1.5.1
+ with:
+ compose-file: "./docker/docker-compose.yml"
+ env:
+ CUSTOM_VARIABLE: "test"
+```
+
+### Example using `services`
+
+Perform `docker-compose up` to some given service instead of all of them
+
+```yaml
+steps:
+ # need checkout before using compose-action
+ - uses: actions/checkout@v3
+ - uses: hoverkraft-tech/compose-action@v1.5.1
+ with:
+ compose-file: "./docker/docker-compose.yml"
+ services: |
+ helloworld2
+ helloworld3
+```
+
+### Example using `up-flags`
+
+Specify flags to pass to the `docker-compose up`. Default is none. Can be used to pass the `--build` flag, for example, if you want persistent volumes to be deleted as well during cleanup. A full list of flags can be found in the [docker-compose up documentation](https://docs.docker.com/compose/reference/up/).
+
+### Example using `down-flags`
+
+Specify flags to pass to the `docker-compose down` command during cleanup. Default is none. Can be used to pass the `--volumes` flag, for example, if you want persistent volumes to be deleted as well during cleanup. A full list of flags can be found in the [docker-compose down documentation](https://docs.docker.com/compose/reference/down/).
+
+### Example using `compose-flags`
+
+Specify flags to pass to the `docker-compose` command. Default is none. A full list of flags can be found in the [docker-compose documentation](https://docs.docker.com/compose/reference/#command-options-overview-and-help).
+
+```yaml
+steps:
+ # need checkout before using compose-action
+ - uses: actions/checkout@v3
+ - uses: hoverkraft-tech/compose-action@v1.5.1
+ with:
+ compose-file: "./docker/docker-compose.yml"
+ services: |
+ helloworld2
+ helloworld3
+```
diff --git a/action.yml b/action.yml
index e550be3..d409f65 100644
--- a/action.yml
+++ b/action.yml
@@ -1,5 +1,5 @@
name: "Docker Compose Action"
-description: "Run your docker-compose file"
+description: "This action runs your docker-compose file and clean up before action finished"
inputs:
compose-file:
description: "Relative path to compose file(s). It can be a list of files."