docs: clarify options

Author: nekowinston

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Test the action
+name: Test
 
 on:
   push: { branches: [main] }
@@ -12,7 +12,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
 
-    name: Test basic usage on ${{ matrix.os }}
+    name: Basic on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
 
     steps:
@@ -31,7 +31,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
 
-    name: Test customized usage on ${{ matrix.os }}
+    name: Customized on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
 
     steps:
@@ -43,7 +43,7 @@ jobs:
         with:
           deno-version: 1.x
           deno-lock-path: "test/customized/deno.lock"
-          scripts-dir: "test/customized/"
+          directory: "test/customized"
 
       - name: Test customized usage
         run: deno run -A --config=./test/customized/deno.json ./test/customized/main.ts

README.md

@@ -7,17 +7,37 @@
 Based on `denoland/setup-deno@v1`, & `actions/cache@v3`, handles `DENO_DIR` and caching for you.\
 Works on Ubuntu, macOS & Windows runners.
 
+### Usage
+
+#### Basic:
+
+```yaml
+- uses: nekowinston/setup-deno@v1
+```
+
+#### All options:
+
+```yaml
+- uses: nekowinston/setup-deno@v1
+  with:
+    deno-version: "~1.38"
+    deno-json-path: ./subdirectory/deno.json
+    deno-lock-path: ./subdirectory/deno.lock
+    directory: ./subdirectory
+```
+
 ### Inputs
 - `deno-version`:\
-  The Deno version to install. Can be a semver version of a stable release, `'canary'` for the latest canary, or the Git hash of a specific canary release.
+  The Deno version to install. Can be a semver version of a stable release, `'canary'` for the latest canary, or the Git hash of a specific canary release.\
+  See [`setup-deno`](https://github.com/marketplace/actions/setup-deno) for examples.\
   Defaults to `1.x`.
 - `deno-json-path`:\
   The path to the Deno config file to use for caching.\
   Defaults to an empty string, using the built-in CLI default.
 - `deno-lock-path`:\
   The path to the lock file to use for caching.\
   Defaults to `./deno.lock`.
-- `scripts-dir`:\
+- `directory`:\
   The path to the scripts to cache. This can be useful if Deno is only part of your repo, and stored in a subdirectory.\
   Defaults to the repo root.
 

action.yml

@@ -14,7 +14,7 @@ inputs:
   deno-lock-path:
     description: "The path to the lock file to use for caching. Defaults to `./deno.lock`."
     default: "./deno.lock"
-  scripts-dir:
+  directory:
     description: "The path to the scripts to cache. Defaults to the repo root."
     default: "."
 
@@ -53,6 +53,6 @@ runs:
       shell: bash
       run: |
         find ${{ runner.os == 'macOS' && '-E' || '' }} \
-          ${{ inputs.scripts-dir }} \
+          ${{ inputs.directory }} \
           -regex '.+\.[tj]sx?$' \
           -exec deno cache {} ${{ inputs.deno-json-path != '' && '--config=' || '' }}${{ inputs.deno-json-path }} \;