better README and lint action

Author: cedi

.github/workflows/lint.yaml

@@ -0,0 +1,17 @@
+name: Validate Composite Action
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Lint workflows and action.yml
+        run: |
+          curl -sSL https://raw.githubusercontent.com/rhysd/actionlint/main/scripts/download-actionlint.bash | bash
+          ./actionlint

README.md

@@ -1,45 +1,68 @@
 # StaticPages Upload GitHub Action
 
-this GitHub Action uploads a static page generated by your static page generator of choice to your self-hosted [Static Pages](https://github.com/SpechtLabs/StaticPages) instance.
+**Easily upload your static website to a self-hosted [Static Pages](https://github.com/SpechtLabs/StaticPages) instance using GitHub OIDC authentication.**
+
+This GitHub Action simplifies deploying static sites (e.g., built with Hugo, VuePress, Astro, etc.) by securely uploading your generated files to a Static Pages backend via a single composite step.
+
+## Features
+
+- Simple integration with any static site generator
+- Secure authentication using GitHub OIDC
+- Fast, parallel file uploads with detailed summaries
+- Upload results available in the GitHub Action summary
+
+## Inputs
+
+| Name       | Description                                                                 | Required | Default |
+|------------|-----------------------------------------------------------------------------|----------|---------|
+| `endpoint` | **Base URL** of your Static Pages API (e.g. `staticpages.example.com`)      | **yes**  | —       |
+| `site-dir` | Path to the directory containing the **generated static site files**        | **yes**  | —       |
+| `verbose`  | Enable verbose curl output (`true` or `false`)                              | no       | `false` |
+
+## Output
+
+| Name             | Description                    |
+|------------------|--------------------------------|
+| `uploaded-count` | The number of files uploaded   |
 
 ## Example Usage
 
 ```yaml
-name: SpechtLabs Static-Pages deploy
+name: Deploy Static Site
 
 on:
   workflow_dispatch:
   push:
     branches: [main]
 
 permissions:
-  id-token: write
-  contents: read
+  id-token: write   # Required for OIDC authentication
+  contents: read    # To read repository contents
 
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - name: Git checkout
-        uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v4
         with:
-          submodules: recursive # fetch Hugo themes
+          submodules: recursive
           fetch-depth: 0
 
-      - name: Init submodules
+      - name: Initialize submodules
         run: git submodule update --init --recursive
 
-      - name: Setup hugo
+      - name: Setup Hugo
         uses: peaceiris/actions-hugo@v2
         with:
           hugo-version: "latest"
           extended: true
 
-      - name: Build
+      - name: Build site
         run: hugo --minify
 
-      - uses: SpechtLabs/StaticPages-Upload@v1
+      - name: Upload to Static Pages
+        uses: SpechtLabs/StaticPages-Upload@v1
         with:
-          apiUrl: https://staticpages.cedi.dev/upload
-          dir: public/
-```
+          endpoint: https://staticpages.example.com
+          site-dir: public/