docs: show correct bun-version-file examples (#86)

* docs: .bun-version * docs: correct bun-version-file examples
oven-sh · Jun 24, 2024 · 3fcae87 · 3fcae87
1 parent 123c6c4
commit 3fcae87
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ Download, install, and setup [Bun](https://bun.sh) in GitHub Actions.
 ```yaml
 - uses: oven-sh/setup-bun@v2
   with:
-    bun-version-file: ".bumrc"
+    bun-version-file: ".bun-version"
 ```
 
 ### Using a custom NPM registry
@@ -52,13 +52,13 @@ In most cases, you shouldn't need to use the [setup-node](https://github.com/act
 
 ## Inputs
 
-| Name               | Description                                           | Default     | Examples                        |
-| ------------------ | ----------------------------------------------------- | ----------- | ------------------------------- |
-| `bun-version`      | The version of Bun to download and install.           | `latest`    | `canary`, `1.0.0`, `1.0.x`      |
-| `bun-version-file` | The version of Bun to download and install from file. | `undefined` | `.bumrc`                        |
-| `bun-download-url` | URL to download .zip file for Bun release             |             |                                 |
-| `registry-url`     | Registry URL where some private package is stored.    | `undefined` | `"https://npm.pkg.github.com/"` |
-| `scope`            | Scope for private packages.                           | `undefined` | `"@foo"`, `"@orgname"`          |
+| Name               | Description                                           | Default     | Examples                                         |
+| ------------------ | ----------------------------------------------------- | ----------- | ------------------------------------------------ |
+| `bun-version`      | The version of Bun to download and install.           | `latest`    | `canary`, `1.0.0`, `1.0.x`                       |
+| `bun-version-file` | The version of Bun to download and install from file. | `undefined` | `package.json`, `.bun-version`, `.tool-versions` |
+| `bun-download-url` | URL to download .zip file for Bun release             |             |                                                  |
+| `registry-url`     | Registry URL where some private package is stored.    | `undefined` | `"https://npm.pkg.github.com/"`                  |
+| `scope`            | Scope for private packages.                           | `undefined` | `"@foo"`, `"@orgname"`                           |
 
 ## Outputs
 

diff --git a/action.yml b/action.yml
@@ -9,7 +9,7 @@ inputs:
     description: 'The version of Bun to install. (e.g. "latest", "canary", "1.0.0", "1.0.x", <sha>)'
     required: false
   bun-version-file:
-    description: 'The version of Bun to install from file. (e.g. "package.json", ".bumrc", ".tool-versions")'
+    description: 'The version of Bun to install from file. (e.g. "package.json", ".bun-version", ".tool-versions")'
     default: ".bun-version"
     required: false
   bun-download-url: