Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hi5a authored Jan 10, 2025
1 parent 2b1e94d commit 323183f
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Combination of these two repos: [S3 Upload Action](https://github.com/hkusu/s3-u
<!-- BASIC USAGE -->
### Basic Usage
```yaml
- uses: ryand56/r2-upload-action@latest
- uses: nordic-game-lab/r2-upload-action@latest
with:
r2-account-id: ${{ secrets.R2_ACCOUNT_ID }}
r2-access-key-id: ${{ secrets.R2_ACCESS_KEY_ID }}
Expand All @@ -29,7 +29,7 @@ Change `destination-dir` input to specify the location of where the directory wi
<!-- CUSTOM USAGE -->
### Custom Usage
```yaml
- uses: ryand56/r2-upload-action@latest # Can be any release
- uses: nordic-game-lab/r2-upload-action@latest # Can be any release
with:
r2-account-id: ${{ secrets.R2_ACCOUNT_ID }}
r2-access-key-id: ${{ secrets.R2_ACCESS_KEY_ID }}
Expand Down Expand Up @@ -57,6 +57,9 @@ See the latest [action.yml](https://github.com/ryand56/r2-upload-action/blob/mas
| `r2-bucket` | **(Required)** Your Cloudflare R2 bucket name. | *N/A* |
| `source-dir` | **(Required)** The directory to upload to the Cloudflare R2 bucket. | *N/A* |
| `destination-dir` | (Optional) The destination to upload the directory to in the Cloudflare R2 bucket. | Empty string |
| `dev-destination-dir` | (Optional) The destination to upload the directory to in the Cloudflare R2 bucket for a development release. | Empty string |
| `prod-destination-dir` | (Optional) The destination to upload the directory to in the Cloudflare R2 bucket for a production release. | Empty string |
| `ref` | (Optional) The ref of where the action is being run, only include if `dev-destination-dir` and `prod-destination-dir` are present. | Empty string |
| `output-file-url` | (Optional) Output the results of the action uploaded files to the `file-urls` output | true |
| `multipart-size` | (Optional) The minimum file size to use multipart file upload | 100 (in MB) |
| `max-retries` | (Optional) The maximum number of retries before failing | 5 |
Expand All @@ -74,4 +77,4 @@ See the latest [action.yml](https://github.com/ryand56/r2-upload-action/blob/mas
<!-- CONTRIBUTING -->
## Contributing

See the [contributing guide](https://github.com/ryand56/r2-upload-action/blob/master/CONTRIBUTING.md) for more detail on how to implement something into the project.
See the [contributing guide](https://github.com/ryand56/r2-upload-action/blob/master/CONTRIBUTING.md) for more detail on how to implement something into the project.

0 comments on commit 323183f

Please sign in to comment.