Add examples to README.md

Author: Ic3w0lf

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{*.yml,*.yaml,*.yaml.tpl}]
+indent_size = 2
+
+[{Makefile,**.mk}]
+indent_style = tab

README.md

@@ -1,16 +1,61 @@
+![Geek Cell GmbH](https://uploads-ssl.webflow.com/61d1d8051145e270217e36a1/61d205833226d492ab02ad46_Group%202.svg "Geek Cell GmbH")
+
+It's 100% Open Source and licensed under the [APACHE2](LICENSE).
+
 <!-- action-docs-description -->
 ## Description
 
-This action makes it possible to run an AWS ECS Fargate task.
+Run an AWS ECS Fargate task and execute a custom commands. See the log output of the commands.
 <!-- action-docs-description -->
 
+### Details
+This action makes it possible to run an AWS ECS Fargate task and execute a custom command. If the task definition
+defines logs to CloudWatch this action will also tail the output of container, providing instant feedback inside
+the GitHub Workflow.
+
+This action is great for executing migrations or other pre/post deployment steps for ECS Fargate applications.
+
 ## Usage
 
+#### Full example
 ``` yaml
----
-#TODO
+- name: Execute migrations and seeders
+  id: run-task
+  uses: geekcell/[email protected]
+  with:
+    cluster: application-cluster
+    task-definition: application-task-def
+    assign-public-ip: 'DISABLED'
+
+    subnet-ids: |
+      subnet-04f133a104b9e95df
+      subnet-0dc419ee6a1483514
+
+    security-group-ids: |
+      sg-123456789101112
+      sg-112398765421333
+
+    tail-logs: true
+    override-container: app
+    override-container-command: |
+      /bin/sh
+      -c
+      php artisan migrate --force --ansi && \
+      php artisan db:seed --force --ansi && \
+      php artisan config:clear --ansi
 ```
 
+#### Minimal example
+``` yaml
+- name: Run migration container
+  id: run-task
+  uses: geekcell/[email protected]
+  with:
+    cluster: application-cluster
+    task-definition: application-task-def
+    subnet-ids: subnet-04f133a104b9e95df
+    security-group-ids: sg-123456789101112
+```
 
 <!-- action-docs-inputs -->
 ## Inputs
@@ -20,24 +65,24 @@ This action makes it possible to run an AWS ECS Fargate task.
 | task-definition | The name or the ARN of the task definition to use for the task. | `true` |  |
 | subnet-ids | The list of subnet IDs for the task to use. If multiple they should be passed as multiline argument with one subnet ID per line. | `true` |  |
 | security-group-ids | List of security group IDs for the task. If multiple they should be passed as multiline argument with one subnet ID per line. | `true` |  |
-| assign-public-ip | Assign public a IP to the task. Options: ['ENABLED', 'DISABLED'] | `false` | DISABLED |
-| cluster | Which ECS cluster to start the task in. | `false` | default |
+| assign-public-ip | Assign public a IP to the task. Options: `['ENABLED', 'DISABLED']` | `false` | DISABLED |
+| cluster | Which ECS cluster to start the task in. | `false` |  |
 | override-container | Will use `containerOverrides` to run a custom command on the container. If provided, `override-container-command` must also be set. | `false` |  |
 | override-container-command | The command to run on the container if `override-container` is passed. | `false` |  |
-| tail-logs | If set to true, will try to extract the logConfiguration for the first container in the task definition. If  `override-container` is passed, it will extract the logConfiguration from that container. Tailing logs is only possible if the provided container uses the `awslogs` logDriver. | `false` | true |
+| tail-logs | If set to true, will try to extract the logConfiguration for the first container in the task definition. If `override-container` is passed, it will extract the logConfiguration from that container. Tailing logs is only possible if the provided container uses the `awslogs` logDriver. | `false` | true |
 <!-- action-docs-inputs -->
 
 <!-- action-docs-outputs -->
 ## Outputs
 
 | parameter | description |
 | --- | --- |
-| task-arn | The full ARN for the task that was ran. |
-| task-id | The ID for the task that was ran. |
+| task-arn | The full ARN for the task that was ran. Will be added as ENV variable. |
+| task-id | The ID for the task that was ran. Will be added as ENV variable. |
 <!-- action-docs-outputs -->
 
 <!-- action-docs-runs -->
 ## Runs
 
-This action is a `node12` action.
+This action is a `node16` action.
 <!-- action-docs-runs -->

action.yml

@@ -1,6 +1,6 @@
 name: 'Run AWS ECS Fargate Task'
 description: >-
-  This action makes it possible to run an AWS ECS Fargate task. 
+  Run an AWS ECS Fargate task and execute a custom commands. See the log output of the commands.
 
 branding:
   icon: 'activity'
@@ -24,14 +24,13 @@ inputs:
   assign-public-ip:
     description: >-
       Assign public a IP to the task.
-      Options: ['ENABLED', 'DISABLED']
+      Options: `['ENABLED', 'DISABLED']`
     required: false
     default: DISABLED
   cluster:
     description: >-
       Which ECS cluster to start the task in.
     required: false
-    default: default
   override-container:
     description: >-
       Will use `containerOverrides` to run a custom command on the container. If provided, `override-container-command`
@@ -43,17 +42,17 @@ inputs:
     required: false
   tail-logs:
     description: >-
-      If set to true, will try to extract the logConfiguration for the first container in the task definition. If 
+      If set to true, will try to extract the logConfiguration for the first container in the task definition. If
       `override-container` is passed, it will extract the logConfiguration from that container. Tailing logs is only
       possible if the provided container uses the `awslogs` logDriver.
     required: false
     default: 'true'
 
 outputs:
   task-arn:
-    description: 'The full ARN for the task that was ran.'
+    description: 'The full ARN for the task that was ran. Will be added as ENV variable.'
   task-id:
-    description: 'The ID for the task that was ran.'
+    description: 'The ID for the task that was ran. Will be added as ENV variable.'
 
 runs:
   using: 'node16'