Add usage in README
Test Workflow / Lint and test library (pull_request) Successful in 8m11s Details

This commit is contained in:
Gleb Koval 2023-12-29 21:10:47 +06:00
parent 571e952897
commit 9f6fad8466
Signed by: cyclane
GPG Key ID: 15E168A8B332382C
1 changed files with 4 additions and 0 deletions

View File

@ -2,6 +2,10 @@
This is a small backup utility for uploading/restoring a local directory to/from This is a small backup utility for uploading/restoring a local directory to/from
an AWS S3 bucket. an AWS S3 bucket.
## Usage
This tool is released as a JAR in the [release page](https://git.koval.net/cyclane/teamcity-executors-test-task/releases).
Use `java -jar <backup-jar-name>.jar --help` for more detailed usage instructions.
## Assumptions ## Assumptions
1. This test task is not interested in re-implementations of common libraries (AWS SDK, Clikt, Gradle Shadow, ...) 1. This test task is not interested in re-implementations of common libraries (AWS SDK, Clikt, Gradle Shadow, ...)
2. The last part (restoration of a single file) should be optimised so that only the part of the blob required for this 2. The last part (restoration of a single file) should be optimised so that only the part of the blob required for this