Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dormant-user committed May 12, 2024
1 parent 3a40051 commit 5996b02
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,13 @@ File Browser for S3 buckets

### Arguments

- **bucket**: Bucket name for which listing has to be created.
- **region**: Region name where the bucket is present. **Fallback:** Default Region
- **filter**: S3 prefix to filter (**eg:** `["github/"]`) **Fallback:** `[]`
- **ignore**: Objects to be ignored (**eg:** `["github/.DS_Store"]`) **Fallback:** `[]`
- **object**: Object name to upload in s3 (**eg:** `list.html`) **Fallback:** `list`
- **proxy**: Proxy server's path (**eg:** https://example.com/proxy) **Fallback:** https://jarvis.vigneshrao.com/proxy
- **style**: Styling for the UI (**eg:** `vanilla`) **Fallback:** bootstrap
- **version**: Get the package version.
- **--bucket / -b**: Bucket name for which listing has to be created.
- **--region / -r**: Region name where the bucket is present. **Fallback:** Default Region
- **--filter / -f**: S3 prefix to filter (**eg:** `["github/"]`) **Fallback:** `[]`
- **--ignore / -i**: Objects to be ignored (**eg:** `["github/.DS_Store"]`) **Fallback:** `[]`
- **--object / -o**: Object name to upload in s3 (**eg:** `list.html`) **Fallback:** `list`
- **--proxy / -p**: Proxy server's path (**eg:** https://example.com/proxy) **Fallback:** https://jarvis.vigneshrao.com/proxy
- **--style / -s**: Styling for the UI (**eg:** `vanilla`) **Fallback:** bootstrap

### Sample

Expand Down

0 comments on commit 5996b02

Please sign in to comment.