chore: update action.yml, README, and package.json for improved clarity and functionality

- Added .gitignore to exclude .cursor files.
- Updated action.yml to include a new input for read-write token and improved descriptions for inputs and outputs.
- Modified README to clarify usage instructions and added a section for setting up the Vercel Blob token.
- Enhanced package.json with a new dependency for @vercel/blob and updated the description for better accuracy.

Author: dartilesm

.gitignore

@@ -0,0 +1 @@
+.cursor

README.md

@@ -1,18 +1,42 @@
 # Vercel Blob Action
 
-This GitHub Action allows you to interact with the Vercel Blob API by specifying a source and destination path. It is designed to facilitate the management of blobs in your Vercel projects.
+This GitHub Action allows you to upload files to Vercel Blob storage by specifying a source file and destination path. It provides an easy way to manage blob storage in your Vercel projects through GitHub Actions workflows.
 
 ## Inputs
 
-- `source`: The source path of the blob you want to manage.
-- `destination`: The destination path where the blob should be moved or copied.
+### `source`
+
+**Required** The source path of the file you want to upload to Vercel Blob storage.
+
+### `destination`
+
+**Required** The destination path where the file should be stored in Vercel Blob storage.
+
+### `read-write-token`
+
+**Required** Your Vercel Blob read-write token (`BLOB_READ_WRITE_TOKEN`). This should be stored as a GitHub secret for security.
+
+## Outputs
+
+### `url`
+
+The URL of the uploaded blob file.
+
+## Environment Variables
+
+This action requires a Vercel Blob read-write token. The action will automatically set the `BLOB_READ_WRITE_TOKEN` environment variable for the Vercel Blob SDK to use. You can obtain this token from your Vercel dashboard:
+
+1. Go to your Vercel dashboard
+2. Navigate to Storage → Blob
+3. Create or copy your `BLOB_READ_WRITE_TOKEN`
+4. Add it as a GitHub secret in your repository
 
 ## Usage
 
-To use this action in your workflow, you can include it as follows:
+To use this action in your workflow, add it as a step in your GitHub Actions workflow file:
 
 ```yaml
-name: Example Workflow
+name: Upload to Vercel Blob
 
 on: [push]
 
@@ -21,27 +45,65 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
-      - name: Upload Blob
-        uses: your-username/vercel-blob-action@v1.0.0
+      - name: Upload file to Vercel Blob
+        uses: your-username/vercel-blob-action@v1
         with:
-          source: 'path/to/source'
-          destination: 'path/to/destination'
+          source: "path/to/your/file.txt"
+          destination: "uploads/file.txt"
+          read-write-token: ${{ secrets.BLOB_READ_WRITE_TOKEN }}
 ```
 
 ## Example
 
-Here is an example of how to specify the source and destination paths:
+Here's a complete example that uploads a build artifact to Vercel Blob storage:
 
 ```yaml
-- name: Upload Blob
-  uses: your-username/vercel-blob-action@v1.0.0
-  with:
-    source: 'src/myBlob.txt'
-    destination: 'dest/myBlob.txt'
+name: Build and Upload
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  build-and-upload:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Build project
+        run: |
+          # Your build commands here
+          echo "Built file" > dist/output.txt
+
+      - name: Upload to Vercel Blob
+        uses: your-username/vercel-blob-action@v1
+        with:
+          source: "dist/output.txt"
+          destination: "builds/output-${{ github.sha }}.txt"
+          read-write-token: ${{ secrets.BLOB_READ_WRITE_TOKEN }}
+
+      - name: Display blob URL
+        run: echo "File uploaded to ${{ steps.upload.outputs.url }}"
 ```
 
+## Setting up the Token
+
+1. **Get your Vercel Blob token:**
+
+   - Visit your [Vercel dashboard](https://vercel.com/dashboard)
+   - Go to Storage → Blob
+   - Create or copy your `BLOB_READ_WRITE_TOKEN`
+
+2. **Add the token to GitHub Secrets:**
+   - Go to your GitHub repository
+   - Navigate to Settings → Secrets and variables → Actions
+   - Click "New repository secret"
+   - Name: `BLOB_READ_WRITE_TOKEN`
+   - Value: Your Vercel Blob token
+
 ## License
 
-This project is licensed under the ISC License.
+This project is licensed under the ISC License.

action.yml

@@ -1,15 +1,21 @@
-name: 'Vercel Blob Action'
-description: 'A GitHub Action to interact with Vercel Blob'
+name: "Vercel Blob Action"
+description: "A GitHub Action to interact with Vercel Blob storage"
 inputs:
   source:
-    description: 'The source path for the blob'
+    description: "The source path for the blob file"
     required: true
   destination:
-    description: 'The destination path for the blob'
+    description: "The destination path for the blob in Vercel Blob storage"
     required: true
+  read-write-token:
+    description: "Vercel Blob read-write token (BLOB_READ_WRITE_TOKEN)"
+    required: true
+outputs:
+  url:
+    description: "The URL of the uploaded blob"
 runs:
-  using: 'node12'
-  main: 'src/index.js'
+  using: "node20"
+  main: "src/index.js"
 branding:
-  icon: 'cloud-upload'
-  color: 'blue'
+  icon: "cloud-upload"
+  color: "blue"

package.json

@@ -1,20 +1,24 @@
 {
   "name": "vercel-blob-action",
   "version": "1.0.0",
-  "description": "A GitHub Action for interacting with Vercel Blob storage.",
+  "description": "A GitHub Action for uploading files to Vercel Blob storage",
   "main": "src/index.js",
+  "type": "module",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [
     "github-action",
     "vercel",
-    "blob"
+    "blob",
+    "storage",
+    "upload"
   ],
   "author": "",
   "license": "ISC",
   "dependencies": {
     "@actions/core": "^1.10.0",
-    "@actions/github": "^5.0.0"
+    "@actions/github": "^5.0.0",
+    "@vercel/blob": "^0.23.4"
   }
 }

src/index.js

@@ -6,22 +6,29 @@ async function run() {
   try {
     const sourcePath = core.getInput('source', { required: true });
     const destinationPath = core.getInput('destination', { required: true });
-    const token = core.getInput('vercelToken', { required: true });
+    const token = core.getInput('read-write-token', { required: true });
+
+    if (!token) {
+      throw new Error('Vercel Blob read-write token is required. Please set the read-write-token input with your BLOB_READ_WRITE_TOKEN.');
+    }
 
     if (!fs.existsSync(sourcePath)) {
       throw new Error(`Source file does not exist: ${sourcePath}`);
     }
 
+    core.info(`Uploading file from ${sourcePath} to ${destinationPath}`);
+
     const fileStream = fs.createReadStream(sourcePath);
 
-    const result = await put(destinationPath, fileStream, {
-      token,
-    });
+    // Set the token as an environment variable for the Vercel Blob SDK
+    process.env.BLOB_READ_WRITE_TOKEN = token;
+
+    const result = await put(destinationPath, fileStream);
 
-    core.info(`File uploaded to ${result.url}`);
+    core.info(`File uploaded successfully to ${result.url}`);
     core.setOutput('url', result.url);
   } catch (error) {
-    core.setFailed(error.message);
+    core.setFailed(`Action failed: ${error.message}`);
   }
 }