feat(readme): ✨ update documentation for inputs and outputs

* clarify `base-url` input with example
* add `github-token` input for issue creation on failure
* document new outputs for API response
* improve overall clarity and structure

Author: mberbero

README.md

@@ -1,20 +1,21 @@
 # Coswarm Deploy GitHub Action
 
-This action sends a deployment request to the Coswarm API. It replicates the manual `curl` call:
-
-```
-curl -L 'http://localhost:3000/api/v1/apps/deploy' \
-  -H 'Content-Type: application/json' \
-  -d '{"token":"app_29fd8aa20b9d48506fe243ec925dec74","image":"redis:alpine"}'
-```
+This Node.js action sends a deployment request to the Coswarm API without relying on local `curl` tooling. On failure, it can automatically create a GitHub issue (using `@actions/core` and `@actions/github`) to alert maintainers—just provide a token with permission to create issues.
 
 ## Inputs
 
 | Name | Required | Description |
 | ---- | -------- | ----------- |
 | `token` | Yes | Deployment token. Store this in a secret such as `COSWARM_DEPLOY_TOKEN`. |
 | `image` | Yes | Container image reference, e.g. `redis:alpine`. |
-| `base-url` | Yes | Coswarm API base URL. |
+| `base-url` | Yes | Coswarm API base URL, e.g. `https://api.coswarm.com`. |
+| `github-token` | No | Token with permission to open issues. Defaults to the `GITHUB_TOKEN` environment variable when omitted. |
+
+## Outputs
+
+| Name | Description |
+| ---- | ----------- |
+| `response` | Raw response body returned by the Coswarm API. |
 
 ## Example workflow
 
@@ -42,4 +43,5 @@ jobs:
           base-url: ${{ secrets.COSWARM_API_URL }}
           token: ${{ secrets.COSWARM_DEPLOY_TOKEN }}
           image: redis:alpine
+          github-token: ${{ github.token }}
 ```

action.yml

@@ -11,24 +11,15 @@ inputs:
   base-url:
     description: "Coswarm API base URL. Must be provided explicitly."
     required: true
+  github-token:
+    description: "Personal access token to create an issue when the deploy fails. Defaults to GITHUB_TOKEN."
+    required: false
+outputs:
+  response:
+    description: "Raw response body returned by the Coswarm API."
 runs:
-  using: "composite"
-  steps:
-    - id: deploy
-      shell: bash
-      run: |
-        set -euo pipefail
-        BASE_URL="${{ inputs.base-url }}"
-        if [[ -z "${BASE_URL}" ]]; then
-          echo "Error: inputs.base-url must be set." >&2
-          exit 1
-        fi
-        # Ensure the URL has no trailing slash before appending the endpoint
-        API_URL="${BASE_URL%%/}/api/v1/apps/deploy"
-        echo "Triggering deploy via ${API_URL}"
-        curl -sS -L "${API_URL}" \
-          -H 'Content-Type: application/json' \
-          -d "$(jq -n --arg token "${{ inputs.token }}" --arg image "${{ inputs.image }}" '{token:$token,image:$image}')"
+  using: "node20"
+  main: "dist/index.js"
 branding:
   icon: "cloud"
   color: "blue"

package-lock.json

@@ -0,0 +1,20 @@
+{
+  "name": "coswarm-deploy-action",
+  "version": "1.0.0",
+  "description": "GitHub Action that triggers Coswarm deployments and files issues on failure.",
+  "main": "dist/index.js",
+  "scripts": {
+    "bundle": "ncc build src/index.js -o dist"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@actions/core": "^1.11.1",
+    "@actions/github": "^6.0.0"
+  },
+  "devDependencies": {
+    "@vercel/ncc": "^0.38.1"
+  }
+}