Update README.md

README.md

@@ -62,8 +62,8 @@ For more details see [action.yaml](action.yaml) and [src/main.sh](src/main.sh).
 | `registry_pass`      |      -       | -                                   | Registry Authentication Password \*       |
 | `summary`            |      -       | `true`                              | Add Job Summary \*                        |
 
-> **¹** Compose Only. View the [Documentation](https://docs.docker.com/reference/cli/docker/compose/up/).  
-> **²** Swarm Only. View the [Documentation](https://docs.docker.com/reference/cli/docker/stack/deploy/).  
+> **¹** Compose Only. View the [Docs](https://docs.docker.com/reference/cli/docker/compose/up/).  
+> **²** Swarm Only. View the [Docs](https://docs.docker.com/reference/cli/docker/stack/deploy/).  
 > \* See Below for more details...
 
 <details><summary>📟 Click Here to see how the deployment command is generated</summary>
@@ -80,38 +80,38 @@ fi
 
 </details>
 
-**name**: Stack name for Swarm and project name for Compose.
+**name:** Stack name for Swarm and project name for Compose.
 
-**mode**: _Compose only._ Set this to `compose` to use `compose up` instead of `stack deploy` for non-swarm hosts.
+**mode:** _Compose only._ Set this to `compose` to use `compose up` instead of `stack deploy` for non-swarm hosts.
 
-**args**: _Compose only._ Compose arguments to pass to the `compose up` command. Only used for `mode: compose` deployments.
+**args:** _Compose only._ Compose arguments to pass to the `compose up` command. Only used for `mode: compose` deployments.
 The `detach` flag defaults to false for compose. With no args the default is `--remove-orphans --force-recreate`.
-Use an empty string to override. For more details, see the compose up
+Use an empty string to override. For more details, see the compose
 [docs](https://docs.docker.com/reference/cli/docker/compose/up/).
 
-**host**: The hostname or IP address of the remote docker server to deploy too.
+**host:** The hostname or IP address of the remote docker server to deploy too.
 If your hostname is behind a proxy like Cloudflare you will need to use the IP address.
 
-**pass/ssh_key**: You must provide either a `pass` or `ssh_key`, but not both.
+**pass/ssh_key:** You must provide either a `pass` or `ssh_key`, but not both.
 
-**env_file**: Variables in this file are exported before running stack deploy.
+**env_file:** Variables in this file are exported before running stack deploy.
 To use a docker `env_file` specify it in your compose file and make it available in a previous step.
 If you need compose file templating this can also be done in a previous step.
 If using `mode: compose` you can also add the `compose_arg: --env-file stringArray`.
 
-**detach**: _Swarm only._ Set this to `false` to not exit immediately and wait for the services to converge.
+**detach:** _Swarm only._ Set this to `false` to not exit immediately and wait for the services to converge.
 This will generate extra output in the logs and is useful for debugging deployments.
 Defaults to `false` in `mode: compose`.
 
-**resolve_image**: _Swarm only._ When the default `always` is used, this argument is omitted.
+**resolve_image:** _Swarm only._ When the default `always` is used, this argument is omitted.
 
-**registry_auth**: _Swarm only._ Set to `true` to deploy with `--with-registry-auth`.
+**registry_auth:** _Swarm only._ Set to `true` to deploy with `--with-registry-auth`.
 
-**registry_host**: To run `docker login` on another registry. Example: `ghcr.io`.
+**registry_host:** To run `docker login` on another registry. Example: `ghcr.io`.
 
-**registry_user/registry_pass**: Required to run `docker login` before stack deploy.
+**registry_user/registry_pass:** Required to run `docker login` before stack deploy.
 
-**summary**: Write a Summary for the job. To disable this set to `false`.
+**summary:** Write a Summary for the job. To disable this set to `false`.
 
 To view a workflow run, click on a recent [Test](https://github.com/cssnr/stack-deploy-action/actions/workflows/test.yaml) job _(requires login)_.